MultiScanner 项目使用教程

1. 项目的目录结构及介绍

MultiScanner 是一个模块化的文件扫描/分析框架，它能够帮助用户通过自动运行一系列工具来评估文件集，并汇总输出结果。以下是项目的目录结构及简要介绍：

• docker_utils: 包含 Docker 相关的实用脚本和配置文件。
• docs: 项目文档。
• etc: 配置文件和示例文件。
• multiscanner: 核心代码和模块。
• .gitignore: 指定 Git 忽略的文件。
• AUTHORS: 项目贡献者列表。
• LICENSE: 项目许可证。
• MANIFEST.in: 包含打包信息。
• README.md: 项目说明文件。
• TODO.md: 待办事项列表。
• docker-compose.yml: Docker Compose 配置文件。
• install.sh: 安装脚本。
• requirements-*: 项目依赖文件。
• setup.cfg: 设置配置文件。
• setup.py: 设置脚本。
• tox.ini: tox 配置文件。

2. 项目的启动文件介绍

项目的启动方式取决于用户选择的使用方式。以下是几种启动 MultiScanner 的方法：

命令行界面

1. 克隆项目仓库：

   git clone https://github.com/mitre/multiscanner.git
   

2. 进入项目目录并执行安装脚本：

   cd multiscanner
   sudo -HE ./install.sh
   

3. 初始化配置文件：

   multiscanner init
   

4. 扫描文件：

   multiscanner <file>
   

Python API

import multiscanner

# 初始化配置
multiscanner.config_init(filepath)

# 扫描文件列表
output = multiscanner.multiscan(file_list)

# 解析报告
results = multiscanner.parse_reports(output, python=True)

Web 界面

1. 克隆项目仓库并启动 Docker 容器：

   git clone https://github.com/mitre/multiscanner.git
   cd multiscanner
   docker-compose up
   

2. 访问 Web 界面：

   http://localhost:8000
   

3. 项目的配置文件介绍

config.ini 是 MultiScanner 的主要配置文件，它控制着项目的运行参数和模块的启用状态。以下是配置文件的一些基本组成部分：

• [DEFAULT]：包含通用设置，如日志级别和临时文件存储路径。
• [modules]：列出了所有可用的模块及其启用状态。用户可以在这里启用或禁用特定的分析模块。
• [report]：定义了报告相关的设置，如报告的存储格式和位置。

用户应根据自己的需求修改 config.ini 中的设置，以适应不同的使用场景。