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
56
57
58
59
//! # A scriptable file/process/network scanner
//!
//! **sscan** is a scriptable file, process, and network scanner.
//! Its high level of configurability is powered by userscripts which run in
//! an embeded [Lua](https://www.lua.org/) virtual machine.
//!
//! Currently, scanning is provided by the
//! [YARA-X](https://virustotal.github.io/yara-x/) scan engine. YARA-X is a
//! Rust implementation of the original YARA scan engine. Additional scan
//! engines may be implemented or integrated in the future.
//!
//! The embedded Lua virtual machine is made possible by the
//! [mlua](https://crates.io/crates/mlua) crate.
//!
//! ## Getting Started
//!
//! First of all, install sscan by running the following:
//!
//! ```bash
//! cargo install --locked sscan
//! ```
//!
//! To try out sscan interactively, run:
//!
//! ```bash
//! sscan interactive
//! ```
//!
//! Or, if you've already created a Lua userscript, run:
//!
//! ```bash
//! sscan run myscript.lua
//! ```
//!
//! The commandline arguments can be abbreviated, as long as they are
//! unambiguous. For example, `sscan int` or `sscan i` will start an
//! interactive session, just like the full command.
//!
//! ## Getting Help
//!
//! To access the built-in help system, call (from Lua):
//!
//! ```lua
//! help() -- View general help overview
//! help:topics() -- List all available help topics
//! help 'topic_name' -- View detailed help on a topic.
//! ```
//!
//! Help topics are also available in the [`topics`] module.
//!
//! [`topics`]: crate::userscript_api::help_system::topics
// Enable pedantic linting
pub