LitterBox 项目安装与使用教程

LitterBox 项目安装与使用教程

LitterBox sandbox approach for malware developers and red teamers to test payloads against detection mechanisms before deployment 项目地址: https://gitcode.com/gh_mirrors/li/LitterBox

1. 项目目录结构及介绍

LitterBox 项目的目录结构如下：

LitterBox/
├── app/                         # 包含Web应用的代码
├── DoppelgangerDB/              # 存储Doppelganger分析结果的数据库
├── FuzzyHash/                   # 存储FuzzyHash分析结果的数据库
├── Scanners/                    # 包含静态分析引擎的代码
├── Screenshots/                 # 存储分析过程中截取的屏幕截图
├── .gitignore                   # 指定git忽略的文件和目录
├── CHANGELOG.md                 # 记录项目的更新日志
├── LICENSE                      # 项目使用的GPL-3.0协议许可文件
├── README.md                    # 项目说明文件
├── litterbox.py                 # 项目的主启动脚本
├── requirements.txt             # 项目依赖的Python包列表
└── config.yml                   # 项目配置文件

• app/ 目录包含构建Web界面的代码。
• DoppelgangerDB/ 和 FuzzyHash/ 目录用于存储分析结果。
• Scanners/ 目录包含静态分析工具的代码。
• Screenshots/ 目录存储分析过程中获取的屏幕截图。
• .gitignore 文件指定了在版本控制中应忽略的文件和目录。
• CHANGELOG.md 文件提供了项目历史更新和修改的详细信息。
• LICENSE 文件描述了项目的开源许可协议。
• README.md 文件介绍了项目的基本信息和使用方法。
• litterbox.py 是项目的主启动脚本，用于启动整个应用。
• requirements.txt 文件列出了项目所需的Python库。
• config.yml 文件用于配置项目运行时的各种参数。

2. 项目的启动文件介绍

项目的启动文件是 litterbox.py。以下是该文件的主要部分及其功能介绍：

# 导入所需的库
from app import create_app

# 创建应用实例
app = create_app()

# 如果是主模块，则启动应用服务
if __name__ == '__main__':
    app.run()

litterbox.py 负责创建一个应用实例，并在直接运行脚本时启动这个应用。它通过 create_app() 函数创建应用，该函数定义了应用的各种配置和功能。

3. 项目的配置文件介绍

项目的配置文件是 config.yml。这个文件包含了项目运行时所需的配置信息，如数据库连接信息、允许的文件扩展名、分析工具的路径、YARA规则的位置、分析超时时间等。

以下是 config.yml 文件的一个基本示例：

# LitterBox 配置文件

# 分析工具路径
tools:
  yara: 'path/to/yara'
  pe_sieve: 'path/to/pe-sieve'
  # 其他工具路径

# 允许的文件扩展名
allowed_extensions:
  - .exe
  - .dll
  - .sys
  - .docx
  - .xlsx
  - .doc
  - .xls
  - .xlsm
  - .docm

# 分析超时设置
analysis_timeout:
  static: 300
  dynamic: 600

# ... 其他配置项

config.yml 文件应与项目的主目录一起放置，并在项目启动时被读取，以便正确配置应用。所有的配置项都可以根据实际需要进行修改，以适应特定的运行环境或需求。

LitterBox sandbox approach for malware developers and red teamers to test payloads against detection mechanisms before deployment 项目地址: https://gitcode.com/gh_mirrors/li/LitterBox