sscan 0.8.0

A scriptable file/process/network scanner
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//! The sscan System Actor
//!
//! The [`System`] actor is responsible for initializing and
//! coordinating all of the moving parts of sscan. It spawns actors,
//! monitors their health, provides additional interoperational
//! capabilities, and helps sscan to gracefully recover in the event
//! of an actor panic.
//!

pub mod messages;

use crate::{lua_vm::LuaVM, yara_engine::YaraEngine};
use kameo::{actor::ActorRef, error::BoxError, mailbox::unbounded::UnboundedMailbox, Actor};

/// Oversees the smooth operation of sscan.
///
/// sscan provides many features and APIs through a system of
/// asynchronous actors. The [`System`] actor coordinates the
/// initialization and lifecycle of all other actors.
#[derive(Default)]
pub struct System {
    lua_vm: Option<ActorRef<LuaVM>>,
    scan_engines: ScanEngines,
}

impl Actor for System {
    type Mailbox = UnboundedMailbox<Self>;

    async fn on_start(&mut self, system: ActorRef<Self>) -> Result<(), BoxError> {
        // Start all actors
        self.lua_vm = Some(kameo::spawn(LuaVM::default()));
        self.scan_engines.yara = Some(kameo::spawn(YaraEngine::default()));

        // Register and link to all actors for health monitoring
        if let Some(ref lua_vm) = self.lua_vm {
            system.link(lua_vm).await;
        }
        if let Some(ref yara_engine) = self.scan_engines.yara {
            system.link(yara_engine).await;
        }

        Ok(())
    }

    fn name() -> &'static str {
        "sscan_system"
    }
}

/// Holds an [`ActorRef`] for each scan engine-type actor.
#[derive(Default)]
struct ScanEngines {
    /// The YARA-X scan engine.
    yara: Option<ActorRef<YaraEngine>>,
}