开源项目 `obfuscation_detection` 安装与使用教程

1. 项目目录结构及介绍

obfuscation_detection 项目的目录结构如下：

obfuscation_detection/
├── examples/
│   └── ...
├── imgs/
│   └── ...
├── obfuscation_detection/
│   └── ...
├── presentation/
│   └── ...
├── scripts/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── __init__.py
├── plugin.json
└── setup.py

目录介绍

• examples/: 包含一些示例文件，展示了如何使用该插件进行代码混淆检测。
• imgs/: 包含项目相关的图片文件。
• obfuscation_detection/: 核心代码目录，包含了插件的主要功能实现。
• presentation/: 包含项目相关的演示文稿文件。
• scripts/: 包含一些脚本文件，用于在命令行中运行插件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• init.py: Python 包初始化文件。
• plugin.json: 插件配置文件。
• setup.py: 项目的安装脚本。

2. 项目启动文件介绍

项目的启动文件主要是 setup.py 和 scripts/detect_obfuscation.py。

setup.py

setup.py 是 Python 项目的标准安装脚本，用于安装项目的依赖和配置。通过运行以下命令可以安装项目：

pip install .

scripts/detect_obfuscation.py

scripts/detect_obfuscation.py 是一个命令行脚本，用于在 headless 模式下运行插件。使用方法如下：

python3 scripts/detect_obfuscation.py <binary>

其中 <binary> 是要检测的二进制文件路径。

3. 项目的配置文件介绍

项目的配置文件主要是 plugin.json。

plugin.json

plugin.json 是 Binary Ninja 插件的配置文件，包含了插件的基本信息和配置选项。以下是一个示例配置文件的内容：

{
  "name": "Obfuscation Detection",
  "author": "Tim Blazytko",
  "version": "2.1",
  "description": "Binary Ninja plugin to detect obfuscated code and interesting code constructs",
  "license": "GPL-2.0",
  "dependencies": []
}

配置项介绍

• name: 插件的名称。
• author: 插件的作者。
• version: 插件的版本号。
• description: 插件的描述信息。
• license: 插件的许可证类型。
• dependencies: 插件的依赖项列表。

通过这些配置项，Binary Ninja 可以正确加载和使用该插件。