| 1 |
|
| 2 |
|
| 3 |
|
| 4 |
|
| 5 |
|
| 6 |
|
| 7 |
|
| 8 |
|
| 9 |
|
| 10 |
|
| 11 |
|
| 12 |
|
| 13 |
|
| 14 |
|
| 15 |
pub mod archive; |
| 16 |
pub mod clamav; |
| 17 |
pub mod content_type; |
| 18 |
pub mod hash_lookup; |
| 19 |
pub mod metadefender; |
| 20 |
pub mod signing_linux; |
| 21 |
pub mod signing_macos; |
| 22 |
pub mod signing_windows; |
| 23 |
pub mod spool; |
| 24 |
pub mod structural; |
| 25 |
pub mod urlhaus; |
| 26 |
pub mod worker; |
| 27 |
pub mod yara; |
| 28 |
|
| 29 |
use serde::Serialize; |
| 30 |
use sha2::{Digest, Sha256}; |
| 31 |
|
| 32 |
use crate::config::ScanConfig; |
| 33 |
use crate::db::FileScanStatus; |
| 34 |
use crate::storage::FileType; |
| 35 |
|
| 36 |
|
| 37 |
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)] |
| 38 |
#[serde(rename_all = "lowercase")] |
| 39 |
pub enum LayerVerdict { |
| 40 |
Pass, |
| 41 |
Fail, |
| 42 |
Skip, |
| 43 |
Error, |
| 44 |
} |
| 45 |
|
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
|
| 53 |
|
| 54 |
|
| 55 |
|
| 56 |
|
| 57 |
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)] |
| 58 |
#[serde(rename_all = "snake_case")] |
| 59 |
pub enum ErrorPolicy { |
| 60 |
FailClosed, |
| 61 |
FailOpen, |
| 62 |
} |
| 63 |
|
| 64 |
|
| 65 |
#[derive(Debug, Clone, Serialize)] |
| 66 |
pub struct LayerResult { |
| 67 |
pub layer: &'static str, |
| 68 |
pub verdict: LayerVerdict, |
| 69 |
pub detail: Option<String>, |
| 70 |
} |
| 71 |
|
| 72 |
|
| 73 |
|
| 74 |
|
| 75 |
fn error_policy_for(layer: &str) -> ErrorPolicy { |
| 76 |
match layer { |
| 77 |
"content_type" => content_type::ERROR_POLICY, |
| 78 |
"structural" => structural::ERROR_POLICY, |
| 79 |
"archive" => archive::ERROR_POLICY, |
| 80 |
"yara" => yara::ERROR_POLICY, |
| 81 |
"clamav" => clamav::ERROR_POLICY, |
| 82 |
"malwarebazaar" => hash_lookup::ERROR_POLICY, |
| 83 |
"urlhaus" => urlhaus::ERROR_POLICY, |
| 84 |
"signing_macos" => signing_macos::ERROR_POLICY, |
| 85 |
"signing_windows" => signing_windows::ERROR_POLICY, |
| 86 |
"signing_linux" => signing_linux::ERROR_POLICY, |
| 87 |
"metadefender" => metadefender::ERROR_POLICY, |
| 88 |
other => { |
| 89 |
tracing::error!(layer = other, "unknown scan layer; defaulting to FailClosed"); |
| 90 |
ErrorPolicy::FailClosed |
| 91 |
} |
| 92 |
} |
| 93 |
} |
| 94 |
|
| 95 |
|
| 96 |
|
| 97 |
|
| 98 |
|
| 99 |
|
| 100 |
fn suspicion_present(layers: &[LayerResult]) -> bool { |
| 101 |
layers.iter().any(|l| { |
| 102 |
match l.verdict { |
| 103 |
LayerVerdict::Fail => true, |
| 104 |
LayerVerdict::Error => error_policy_for(l.layer) == ErrorPolicy::FailClosed, |
| 105 |
_ => false, |
| 106 |
} |
| 107 |
}) |
| 108 |
} |
| 109 |
|
| 110 |
|
| 111 |
|
| 112 |
|
| 113 |
|
| 114 |
|
| 115 |
|
| 116 |
|
| 117 |
|
| 118 |
fn final_status(layers: &[LayerResult]) -> FileScanStatus { |
| 119 |
if layers.iter().any(|l| l.verdict == LayerVerdict::Fail) { |
| 120 |
return FileScanStatus::Quarantined; |
| 121 |
} |
| 122 |
let has_fail_closed_error = layers.iter().any(|l| { |
| 123 |
l.verdict == LayerVerdict::Error && error_policy_for(l.layer) == ErrorPolicy::FailClosed |
| 124 |
}); |
| 125 |
if has_fail_closed_error { |
| 126 |
FileScanStatus::HeldForReview |
| 127 |
} else { |
| 128 |
FileScanStatus::Clean |
| 129 |
} |
| 130 |
} |
| 131 |
|
| 132 |
|
| 133 |
#[derive(Debug, Clone)] |
| 134 |
pub struct ScanResult { |
| 135 |
pub status: FileScanStatus, |
| 136 |
pub layers: Vec<LayerResult>, |
| 137 |
pub sha256: String, |
| 138 |
pub file_size: u64, |
| 139 |
} |
| 140 |
|
| 141 |
|
| 142 |
pub struct ScanPipeline { |
| 143 |
yara_rules: Option<yara_x::Rules>, |
| 144 |
|
| 145 |
yara_rule_count: usize, |
| 146 |
yara_min_rule_files: usize, |
| 147 |
clamav_socket: Option<String>, |
| 148 |
malwarebazaar_enabled: bool, |
| 149 |
urlhaus_enabled: bool, |
| 150 |
abuse_ch_auth_key: Option<String>, |
| 151 |
metadefender_api_key: Option<String>, |
| 152 |
} |
| 153 |
|
| 154 |
impl ScanPipeline { |
| 155 |
|
| 156 |
pub fn new(config: &ScanConfig) -> Result<Self, String> { |
| 157 |
let (yara_rules, yara_rule_count) = yara::compile_rules_from_dir(&config.yara_rules_dir)?; |
| 158 |
|
| 159 |
Ok(ScanPipeline { |
| 160 |
yara_rules, |
| 161 |
yara_rule_count, |
| 162 |
yara_min_rule_files: config.yara_min_rule_files, |
| 163 |
clamav_socket: config.clamav_socket.clone(), |
| 164 |
malwarebazaar_enabled: config.malwarebazaar_enabled, |
| 165 |
urlhaus_enabled: config.urlhaus_enabled, |
| 166 |
abuse_ch_auth_key: config.abuse_ch_auth_key.clone(), |
| 167 |
metadefender_api_key: config.metadefender_api_key.clone(), |
| 168 |
}) |
| 169 |
} |
| 170 |
|
| 171 |
|
| 172 |
|
| 173 |
|
| 174 |
|
| 175 |
|
| 176 |
pub async fn assert_live(&self) -> Result<(), String> { |
| 177 |
let mut live_layers: Vec<&str> = Vec::new(); |
| 178 |
if let Some(ref socket) = self.clamav_socket { |
| 179 |
match clamav::ping(socket).await { |
| 180 |
Ok(()) => live_layers.push("clamav"), |
| 181 |
Err(e) => { |
| 182 |
return Err(format!("ClamAV socket {socket} unreachable: {e}")); |
| 183 |
} |
| 184 |
} |
| 185 |
} |
| 186 |
if self.yara_rules.is_some() { |
| 187 |
|
| 188 |
|
| 189 |
|
| 190 |
|
| 191 |
if self.yara_min_rule_files > 0 && self.yara_rule_count < self.yara_min_rule_files { |
| 192 |
return Err(format!( |
| 193 |
"YARA corpus degraded: {} rule files compiled, below the configured \ |
| 194 |
floor of {} (YARA_MIN_RULE_FILES). Refusing to boot — a silently \ |
| 195 |
shrunken rule set is false coverage.", |
| 196 |
self.yara_rule_count, self.yara_min_rule_files, |
| 197 |
)); |
| 198 |
} |
| 199 |
live_layers.push("yara"); |
| 200 |
} |
| 201 |
if self.malwarebazaar_enabled { |
| 202 |
live_layers.push("malwarebazaar"); |
| 203 |
} |
| 204 |
if self.urlhaus_enabled { |
| 205 |
live_layers.push("urlhaus"); |
| 206 |
} |
| 207 |
if self.metadefender_api_key.is_some() { |
| 208 |
live_layers.push("metadefender"); |
| 209 |
} |
| 210 |
if live_layers.is_empty() { |
| 211 |
return Err( |
| 212 |
"Scanning configured but no AV layer is live (no ClamAV socket, \ |
| 213 |
no YARA rules, no remote API keys). Refusing to boot — the \ |
| 214 |
FailOpen policy would pass every upload as Clean." |
| 215 |
.to_string(), |
| 216 |
); |
| 217 |
} |
| 218 |
tracing::info!(layers = ?live_layers, "scan pipeline live layers asserted"); |
| 219 |
Ok(()) |
| 220 |
} |
| 221 |
|
| 222 |
|
| 223 |
|
| 224 |
|
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
pub async fn scan(self: std::sync::Arc<Self>, data: Vec<u8>, file_type: FileType) -> ScanResult { |
| 230 |
let file_size = data.len() as u64; |
| 231 |
let data = std::sync::Arc::<[u8]>::from(data); |
| 232 |
|
| 233 |
|
| 234 |
let sync_data = std::sync::Arc::clone(&data); |
| 235 |
let sync_self = std::sync::Arc::clone(&self); |
| 236 |
let sync_fut = tokio::task::spawn_blocking(move || sync_self.run_sync_layers(&sync_data, file_type)); |
| 237 |
|
| 238 |
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 |
let clamav_data = std::sync::Arc::clone(&data); |
| 243 |
let clamav_socket = self.clamav_socket.clone(); |
| 244 |
let clamav_fut = async move { |
| 245 |
match clamav_socket { |
| 246 |
Some(socket) => clamav::scan_with_clamav(&socket, &clamav_data).await, |
| 247 |
None => LayerResult { |
| 248 |
layer: "clamav", |
| 249 |
verdict: LayerVerdict::Skip, |
| 250 |
detail: Some("ClamAV not configured".to_string()), |
| 251 |
}, |
| 252 |
} |
| 253 |
}; |
| 254 |
|
| 255 |
|
| 256 |
|
| 257 |
let urlhaus_data = std::sync::Arc::clone(&data); |
| 258 |
let urlhaus_enabled = self.urlhaus_enabled; |
| 259 |
let urlhaus_key = self.abuse_ch_auth_key.clone(); |
| 260 |
let urlhaus_fut = async move { |
| 261 |
if urlhaus_enabled { |
| 262 |
urlhaus::check_urlhaus(&urlhaus_data, urlhaus_key.as_deref()).await |
| 263 |
} else { |
| 264 |
LayerResult { |
| 265 |
layer: "urlhaus", |
| 266 |
verdict: LayerVerdict::Skip, |
| 267 |
detail: Some("URLhaus lookups disabled".to_string()), |
| 268 |
} |
| 269 |
} |
| 270 |
}; |
| 271 |
|
| 272 |
let (sync_result, clamav_result, urlhaus_result) = |
| 273 |
tokio::join!(sync_fut, clamav_fut, urlhaus_fut); |
| 274 |
let (mut layers, sha256) = sync_result |
| 275 |
.expect("scan_sync spawn_blocking panicked"); |
| 276 |
layers.push(clamav_result); |
| 277 |
layers.push(urlhaus_result); |
| 278 |
|
| 279 |
|
| 280 |
layers.push(if self.malwarebazaar_enabled { |
| 281 |
hash_lookup::check_malwarebazaar(&sha256, self.abuse_ch_auth_key.as_deref()).await |
| 282 |
} else { |
| 283 |
LayerResult { |
| 284 |
layer: "malwarebazaar", |
| 285 |
verdict: LayerVerdict::Skip, |
| 286 |
detail: Some("MalwareBazaar lookups disabled".to_string()), |
| 287 |
} |
| 288 |
}); |
| 289 |
|
| 290 |
|
| 291 |
|
| 292 |
|
| 293 |
layers.push(if suspicion_present(&layers) { |
| 294 |
metadefender::check_metadefender(&sha256, self.metadefender_api_key.as_deref()).await |
| 295 |
} else { |
| 296 |
LayerResult { |
| 297 |
layer: "metadefender", |
| 298 |
verdict: LayerVerdict::Skip, |
| 299 |
detail: Some("No prior suspicion; second-opinion not invoked".to_string()), |
| 300 |
} |
| 301 |
}); |
| 302 |
|
| 303 |
let status = final_status(&layers); |
| 304 |
|
| 305 |
ScanResult { |
| 306 |
status, |
| 307 |
layers, |
| 308 |
sha256, |
| 309 |
file_size, |
| 310 |
} |
| 311 |
} |
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
pub async fn scan_stream( |
| 319 |
self: std::sync::Arc<Self>, |
| 320 |
spool: spool::SpoolHandle, |
| 321 |
file_type: FileType, |
| 322 |
) -> ScanResult { |
| 323 |
let file_size = std::fs::metadata(spool.path()) |
| 324 |
.map(|m| m.len()) |
| 325 |
.unwrap_or(0); |
| 326 |
|
| 327 |
let map = match spool::mmap_read(spool.path()) { |
| 328 |
Ok(m) => std::sync::Arc::new(m), |
| 329 |
Err(e) => { |
| 330 |
let layer = LayerResult { |
| 331 |
layer: "spool", |
| 332 |
verdict: LayerVerdict::Error, |
| 333 |
detail: Some(e), |
| 334 |
}; |
| 335 |
return ScanResult { |
| 336 |
status: final_status(std::slice::from_ref(&layer)), |
| 337 |
layers: vec![layer], |
| 338 |
sha256: String::new(), |
| 339 |
file_size, |
| 340 |
}; |
| 341 |
} |
| 342 |
}; |
| 343 |
|
| 344 |
let sync_map = std::sync::Arc::clone(&map); |
| 345 |
let sync_self = std::sync::Arc::clone(&self); |
| 346 |
let sync_fut = tokio::task::spawn_blocking(move || sync_self.run_sync_layers(&sync_map, file_type)); |
| 347 |
|
| 348 |
let clamav_socket = self.clamav_socket.clone(); |
| 349 |
let clamav_path = spool.path().to_path_buf(); |
| 350 |
let clamav_fut = async move { |
| 351 |
match clamav_socket { |
| 352 |
Some(socket) => match tokio::fs::File::open(&clamav_path).await { |
| 353 |
Ok(file) => clamav::scan_with_clamav_stream(&socket, file).await, |
| 354 |
Err(e) => LayerResult { |
| 355 |
layer: "clamav", |
| 356 |
verdict: LayerVerdict::Error, |
| 357 |
detail: Some(format!("open spool for clamav: {e}")), |
| 358 |
}, |
| 359 |
}, |
| 360 |
None => LayerResult { |
| 361 |
layer: "clamav", |
| 362 |
verdict: LayerVerdict::Skip, |
| 363 |
detail: Some("ClamAV not configured".to_string()), |
| 364 |
}, |
| 365 |
} |
| 366 |
}; |
| 367 |
|
| 368 |
let urlhaus_map = std::sync::Arc::clone(&map); |
| 369 |
let urlhaus_enabled = self.urlhaus_enabled; |
| 370 |
let urlhaus_key = self.abuse_ch_auth_key.clone(); |
| 371 |
let urlhaus_fut = async move { |
| 372 |
if urlhaus_enabled { |
| 373 |
urlhaus::check_urlhaus(&urlhaus_map, urlhaus_key.as_deref()).await |
| 374 |
} else { |
| 375 |
LayerResult { |
| 376 |
layer: "urlhaus", |
| 377 |
verdict: LayerVerdict::Skip, |
| 378 |
detail: Some("URLhaus lookups disabled".to_string()), |
| 379 |
} |
| 380 |
} |
| 381 |
}; |
| 382 |
|
| 383 |
let (sync_result, clamav_result, urlhaus_result) = |
| 384 |
tokio::join!(sync_fut, clamav_fut, urlhaus_fut); |
| 385 |
let (mut layers, sha256) = sync_result |
| 386 |
.expect("scan_stream sync spawn_blocking panicked"); |
| 387 |
layers.push(clamav_result); |
| 388 |
layers.push(urlhaus_result); |
| 389 |
|
| 390 |
layers.push(if self.malwarebazaar_enabled { |
| 391 |
hash_lookup::check_malwarebazaar(&sha256, self.abuse_ch_auth_key.as_deref()).await |
| 392 |
} else { |
| 393 |
LayerResult { |
| 394 |
layer: "malwarebazaar", |
| 395 |
verdict: LayerVerdict::Skip, |
| 396 |
detail: Some("MalwareBazaar lookups disabled".to_string()), |
| 397 |
} |
| 398 |
}); |
| 399 |
|
| 400 |
layers.push(if suspicion_present(&layers) { |
| 401 |
metadefender::check_metadefender(&sha256, self.metadefender_api_key.as_deref()).await |
| 402 |
} else { |
| 403 |
LayerResult { |
| 404 |
layer: "metadefender", |
| 405 |
verdict: LayerVerdict::Skip, |
| 406 |
detail: Some("No prior suspicion; second-opinion not invoked".to_string()), |
| 407 |
} |
| 408 |
}); |
| 409 |
|
| 410 |
let status = final_status(&layers); |
| 411 |
drop(map); |
| 412 |
drop(spool); |
| 413 |
|
| 414 |
ScanResult { |
| 415 |
status, |
| 416 |
layers, |
| 417 |
sha256, |
| 418 |
file_size, |
| 419 |
} |
| 420 |
} |
| 421 |
|
| 422 |
|
| 423 |
fn run_sync_layers(&self, data: &[u8], file_type: FileType) -> (Vec<LayerResult>, String) { |
| 424 |
let mut layers = Vec::with_capacity(5); |
| 425 |
|
| 426 |
|
| 427 |
let sha256 = { |
| 428 |
let mut hasher = Sha256::new(); |
| 429 |
hasher.update(data); |
| 430 |
hex::encode(hasher.finalize()) |
| 431 |
}; |
| 432 |
|
| 433 |
layers.push(content_type::verify_content_type(data, file_type)); |
| 434 |
layers.push(structural::analyze_binary(data, file_type)); |
| 435 |
layers.push(archive::check_archive_safety(data, file_type)); |
| 436 |
layers.push(match self.yara_rules { |
| 437 |
Some(ref rules) => yara::scan_with_yara(rules, data), |
| 438 |
None => LayerResult { |
| 439 |
layer: "yara", |
| 440 |
verdict: LayerVerdict::Skip, |
| 441 |
detail: Some("No YARA rules loaded".to_string()), |
| 442 |
}, |
| 443 |
}); |
| 444 |
layers.push(signing_macos::verify_apple_signature(data, file_type)); |
| 445 |
layers.push(signing_windows::verify_authenticode(data, file_type)); |
| 446 |
layers.push(signing_linux::verify_appimage_signature(data, file_type)); |
| 447 |
|
| 448 |
(layers, sha256) |
| 449 |
} |
| 450 |
} |
| 451 |
|
| 452 |
#[cfg(test)] |
| 453 |
mod tests { |
| 454 |
use super::*; |
| 455 |
|
| 456 |
#[test] |
| 457 |
fn layer_verdict_serializes_lowercase() { |
| 458 |
assert_eq!( |
| 459 |
serde_json::to_string(&LayerVerdict::Pass).unwrap(), |
| 460 |
"\"pass\"" |
| 461 |
); |
| 462 |
assert_eq!( |
| 463 |
serde_json::to_string(&LayerVerdict::Fail).unwrap(), |
| 464 |
"\"fail\"" |
| 465 |
); |
| 466 |
assert_eq!( |
| 467 |
serde_json::to_string(&LayerVerdict::Skip).unwrap(), |
| 468 |
"\"skip\"" |
| 469 |
); |
| 470 |
assert_eq!( |
| 471 |
serde_json::to_string(&LayerVerdict::Error).unwrap(), |
| 472 |
"\"error\"" |
| 473 |
); |
| 474 |
} |
| 475 |
|
| 476 |
#[test] |
| 477 |
fn scan_result_quarantined_on_any_fail() { |
| 478 |
let layers = [ |
| 479 |
LayerResult { |
| 480 |
layer: "test1", |
| 481 |
verdict: LayerVerdict::Pass, |
| 482 |
detail: None, |
| 483 |
}, |
| 484 |
LayerResult { |
| 485 |
layer: "test2", |
| 486 |
verdict: LayerVerdict::Fail, |
| 487 |
detail: Some("bad".to_string()), |
| 488 |
}, |
| 489 |
]; |
| 490 |
let has_fail = layers.iter().any(|l| l.verdict == LayerVerdict::Fail); |
| 491 |
assert!(has_fail); |
| 492 |
} |
| 493 |
|
| 494 |
#[test] |
| 495 |
fn sha256_computation() { |
| 496 |
let mut hasher = Sha256::new(); |
| 497 |
hasher.update(b"hello"); |
| 498 |
let hash = hex::encode(hasher.finalize()); |
| 499 |
assert_eq!( |
| 500 |
hash, |
| 501 |
"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824" |
| 502 |
); |
| 503 |
} |
| 504 |
|
| 505 |
|
| 506 |
|
| 507 |
|
| 508 |
|
| 509 |
fn make_pipeline() -> std::sync::Arc<ScanPipeline> { |
| 510 |
std::sync::Arc::new(ScanPipeline { |
| 511 |
yara_rules: None, |
| 512 |
yara_rule_count: 0, |
| 513 |
yara_min_rule_files: 0, |
| 514 |
clamav_socket: None, |
| 515 |
malwarebazaar_enabled: false, |
| 516 |
urlhaus_enabled: false, |
| 517 |
abuse_ch_auth_key: None, |
| 518 |
metadefender_api_key: None, |
| 519 |
}) |
| 520 |
} |
| 521 |
|
| 522 |
#[tokio::test] |
| 523 |
async fn pipeline_clean_download_passes() { |
| 524 |
let pipeline = make_pipeline(); |
| 525 |
let result = pipeline.clone().scan(b"just some file content".to_vec(), FileType::Download).await; |
| 526 |
assert_eq!(result.status, FileScanStatus::Clean); |
| 527 |
assert_eq!(result.file_size, 22); |
| 528 |
assert!(!result.sha256.is_empty()); |
| 529 |
assert_eq!(result.layers.len(), 11); |
| 530 |
} |
| 531 |
|
| 532 |
#[tokio::test] |
| 533 |
async fn pipeline_unrecognized_audio_quarantined() { |
| 534 |
let pipeline = make_pipeline(); |
| 535 |
|
| 536 |
let result = pipeline.clone().scan(b"audio data here".to_vec(), FileType::Audio).await; |
| 537 |
assert_eq!(result.status, FileScanStatus::Quarantined); |
| 538 |
} |
| 539 |
|
| 540 |
#[tokio::test] |
| 541 |
async fn pipeline_clean_cover_passes() { |
| 542 |
let pipeline = make_pipeline(); |
| 543 |
|
| 544 |
let png = [0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A]; |
| 545 |
let result = pipeline.clone().scan(png.to_vec(), FileType::Cover).await; |
| 546 |
assert_eq!(result.status, FileScanStatus::Clean); |
| 547 |
} |
| 548 |
|
| 549 |
#[tokio::test] |
| 550 |
async fn pipeline_pe_as_audio_quarantined() { |
| 551 |
let pipeline = make_pipeline(); |
| 552 |
|
| 553 |
let pe_header = b"MZ\x90\x00\x03\x00\x00\x00"; |
| 554 |
let result = pipeline.clone().scan(pe_header.to_vec(), FileType::Audio).await; |
| 555 |
assert_eq!(result.status, FileScanStatus::Quarantined); |
| 556 |
|
| 557 |
let content_type_layer = result.layers.iter().find(|l| l.layer == "content_type").unwrap(); |
| 558 |
assert_eq!(content_type_layer.verdict, LayerVerdict::Fail); |
| 559 |
} |
| 560 |
|
| 561 |
#[tokio::test] |
| 562 |
async fn pipeline_pe_as_cover_quarantined() { |
| 563 |
let pipeline = make_pipeline(); |
| 564 |
let pe_header = b"MZ\x90\x00\x03\x00\x00\x00"; |
| 565 |
let result = pipeline.clone().scan(pe_header.to_vec(), FileType::Cover).await; |
| 566 |
assert_eq!(result.status, FileScanStatus::Quarantined); |
| 567 |
} |
| 568 |
|
| 569 |
#[tokio::test] |
| 570 |
async fn pipeline_sha256_is_deterministic() { |
| 571 |
let pipeline = make_pipeline(); |
| 572 |
let data = b"deterministic hash test"; |
| 573 |
let r1 = pipeline.clone().scan(data.to_vec(), FileType::Download).await; |
| 574 |
let r2 = pipeline.clone().scan(data.to_vec(), FileType::Download).await; |
| 575 |
assert_eq!(r1.sha256, r2.sha256); |
| 576 |
} |
| 577 |
|
| 578 |
#[tokio::test] |
| 579 |
async fn pipeline_skips_optional_layers_when_unconfigured() { |
| 580 |
let pipeline = make_pipeline(); |
| 581 |
let result = pipeline.clone().scan(b"test".to_vec(), FileType::Download).await; |
| 582 |
|
| 583 |
let yara = result.layers.iter().find(|l| l.layer == "yara").unwrap(); |
| 584 |
assert_eq!(yara.verdict, LayerVerdict::Skip); |
| 585 |
|
| 586 |
let clamav = result.layers.iter().find(|l| l.layer == "clamav").unwrap(); |
| 587 |
assert_eq!(clamav.verdict, LayerVerdict::Skip); |
| 588 |
|
| 589 |
let mb = result.layers.iter().find(|l| l.layer == "malwarebazaar").unwrap(); |
| 590 |
assert_eq!(mb.verdict, LayerVerdict::Skip); |
| 591 |
|
| 592 |
let uh = result.layers.iter().find(|l| l.layer == "urlhaus").unwrap(); |
| 593 |
assert_eq!(uh.verdict, LayerVerdict::Skip); |
| 594 |
} |
| 595 |
|
| 596 |
#[tokio::test] |
| 597 |
async fn pipeline_always_produces_11_layers() { |
| 598 |
let pipeline = make_pipeline(); |
| 599 |
for file_type in [FileType::Audio, FileType::Cover, FileType::Download] { |
| 600 |
let result = pipeline.clone().scan(b"data".to_vec(), file_type).await; |
| 601 |
assert_eq!(result.layers.len(), 11, "Expected 11 layers for {:?}", file_type); |
| 602 |
} |
| 603 |
} |
| 604 |
|
| 605 |
#[test] |
| 606 |
fn suspicion_present_on_fail() { |
| 607 |
let layers = vec![pass("content_type"), fail("yara")]; |
| 608 |
assert!(suspicion_present(&layers)); |
| 609 |
} |
| 610 |
|
| 611 |
#[test] |
| 612 |
fn suspicion_present_on_fail_closed_error() { |
| 613 |
let layers = vec![pass("content_type"), err("archive")]; |
| 614 |
assert!(suspicion_present(&layers)); |
| 615 |
} |
| 616 |
|
| 617 |
#[test] |
| 618 |
fn no_suspicion_when_fail_open_error_only() { |
| 619 |
|
| 620 |
|
| 621 |
let layers = vec![pass("content_type"), err("malwarebazaar"), err("urlhaus")]; |
| 622 |
assert!(!suspicion_present(&layers)); |
| 623 |
} |
| 624 |
|
| 625 |
#[test] |
| 626 |
fn no_suspicion_when_all_clean() { |
| 627 |
let layers = vec![pass("content_type"), skip("yara"), pass("structural")]; |
| 628 |
assert!(!suspicion_present(&layers)); |
| 629 |
} |
| 630 |
|
| 631 |
#[tokio::test] |
| 632 |
async fn pipeline_errors_held_for_review() { |
| 633 |
|
| 634 |
|
| 635 |
let pipeline = make_pipeline(); |
| 636 |
|
| 637 |
let mut data = vec![0x50, 0x4B, 0x03, 0x04]; |
| 638 |
data.extend_from_slice(&[0xFF; 100]); |
| 639 |
let result = pipeline.clone().scan(data, FileType::Download).await; |
| 640 |
let archive = result.layers.iter().find(|l| l.layer == "archive").unwrap(); |
| 641 |
assert_eq!(archive.verdict, LayerVerdict::Error); |
| 642 |
assert_eq!(result.status, FileScanStatus::HeldForReview); |
| 643 |
} |
| 644 |
|
| 645 |
|
| 646 |
|
| 647 |
fn err(layer: &'static str) -> LayerResult { |
| 648 |
LayerResult { layer, verdict: LayerVerdict::Error, detail: None } |
| 649 |
} |
| 650 |
fn pass(layer: &'static str) -> LayerResult { |
| 651 |
LayerResult { layer, verdict: LayerVerdict::Pass, detail: None } |
| 652 |
} |
| 653 |
fn skip(layer: &'static str) -> LayerResult { |
| 654 |
LayerResult { layer, verdict: LayerVerdict::Skip, detail: None } |
| 655 |
} |
| 656 |
fn fail(layer: &'static str) -> LayerResult { |
| 657 |
LayerResult { layer, verdict: LayerVerdict::Fail, detail: None } |
| 658 |
} |
| 659 |
|
| 660 |
#[test] |
| 661 |
fn final_status_clean_when_all_pass() { |
| 662 |
let layers = vec![pass("content_type"), pass("structural"), pass("archive"), skip("yara"), skip("clamav"), skip("malwarebazaar")]; |
| 663 |
assert_eq!(final_status(&layers), FileScanStatus::Clean); |
| 664 |
} |
| 665 |
|
| 666 |
#[test] |
| 667 |
fn final_status_quarantined_on_any_fail() { |
| 668 |
let layers = vec![pass("content_type"), fail("yara"), skip("clamav")]; |
| 669 |
assert_eq!(final_status(&layers), FileScanStatus::Quarantined); |
| 670 |
} |
| 671 |
|
| 672 |
#[test] |
| 673 |
fn final_status_fail_beats_error() { |
| 674 |
|
| 675 |
let layers = vec![err("malwarebazaar"), fail("yara")]; |
| 676 |
assert_eq!(final_status(&layers), FileScanStatus::Quarantined); |
| 677 |
} |
| 678 |
|
| 679 |
#[test] |
| 680 |
fn final_status_held_on_fail_closed_error() { |
| 681 |
|
| 682 |
let layers = vec![pass("content_type"), err("archive"), skip("clamav")]; |
| 683 |
assert_eq!(final_status(&layers), FileScanStatus::HeldForReview); |
| 684 |
} |
| 685 |
|
| 686 |
#[test] |
| 687 |
fn final_status_clean_on_fail_open_error_only() { |
| 688 |
|
| 689 |
|
| 690 |
let layers = vec![pass("content_type"), pass("structural"), pass("archive"), skip("yara"), skip("clamav"), err("malwarebazaar")]; |
| 691 |
assert_eq!(final_status(&layers), FileScanStatus::Clean); |
| 692 |
} |
| 693 |
|
| 694 |
#[test] |
| 695 |
fn final_status_clean_when_all_external_layers_error() { |
| 696 |
|
| 697 |
|
| 698 |
|
| 699 |
let layers = vec![pass("content_type"), pass("structural"), pass("archive"), skip("yara"), err("clamav"), err("malwarebazaar")]; |
| 700 |
assert_eq!(final_status(&layers), FileScanStatus::Clean); |
| 701 |
} |
| 702 |
|
| 703 |
#[test] |
| 704 |
fn final_status_held_on_unknown_layer_error() { |
| 705 |
|
| 706 |
|
| 707 |
|
| 708 |
let layers = vec![pass("content_type"), err("brand_new_layer_someone_forgot_to_register")]; |
| 709 |
assert_eq!(final_status(&layers), FileScanStatus::HeldForReview); |
| 710 |
} |
| 711 |
|
| 712 |
#[test] |
| 713 |
fn error_policy_for_all_known_layers() { |
| 714 |
|
| 715 |
|
| 716 |
|
| 717 |
for name in ["content_type", "structural", "archive", "yara", "clamav", "malwarebazaar"] { |
| 718 |
let policy = error_policy_for(name); |
| 719 |
|
| 720 |
|
| 721 |
|
| 722 |
|
| 723 |
let _ = policy; |
| 724 |
} |
| 725 |
} |
| 726 |
|
| 727 |
#[test] |
| 728 |
fn content_type_is_fail_closed() { assert_eq!(error_policy_for("content_type"), ErrorPolicy::FailClosed); } |
| 729 |
#[test] |
| 730 |
fn structural_is_fail_closed() { assert_eq!(error_policy_for("structural"), ErrorPolicy::FailClosed); } |
| 731 |
#[test] |
| 732 |
fn archive_is_fail_closed() { assert_eq!(error_policy_for("archive"), ErrorPolicy::FailClosed); } |
| 733 |
#[test] |
| 734 |
fn yara_is_fail_closed() { assert_eq!(error_policy_for("yara"), ErrorPolicy::FailClosed); } |
| 735 |
#[test] |
| 736 |
fn clamav_is_fail_open() { assert_eq!(error_policy_for("clamav"), ErrorPolicy::FailOpen); } |
| 737 |
#[test] |
| 738 |
fn malwarebazaar_is_fail_open() { assert_eq!(error_policy_for("malwarebazaar"), ErrorPolicy::FailOpen); } |
| 739 |
#[test] |
| 740 |
fn urlhaus_is_fail_open() { assert_eq!(error_policy_for("urlhaus"), ErrorPolicy::FailOpen); } |
| 741 |
#[test] |
| 742 |
fn signing_macos_is_fail_open() { assert_eq!(error_policy_for("signing_macos"), ErrorPolicy::FailOpen); } |
| 743 |
#[test] |
| 744 |
fn metadefender_is_fail_open() { assert_eq!(error_policy_for("metadefender"), ErrorPolicy::FailOpen); } |
| 745 |
#[test] |
| 746 |
fn signing_windows_is_fail_open() { assert_eq!(error_policy_for("signing_windows"), ErrorPolicy::FailOpen); } |
| 747 |
#[test] |
| 748 |
fn signing_linux_is_fail_open() { assert_eq!(error_policy_for("signing_linux"), ErrorPolicy::FailOpen); } |
| 749 |
} |
| 750 |
|