binaryanalysisplatform/bap-toolkit

BAP Toolkit 镜像文档

镜像概述和主要用途

BAP Toolkit是一个二进制分析工具集合，基于BAP（Binary Analysis Platform）框架构建。它提供了一系列现成的二进制分析工具，同时包含工具开发框架和标准化仓库结构，便于开发新的分析工具。该镜像旨在作为协作平台，鼓励社区成员贡献工具，支持代码质量检查、编码标准合规性验证和漏洞检测等场景。

核心功能和特性

编码标准合规性检查

• Joint Strike Fighter (JSF) 编码标准：包含多项规则检查，如函数圈复杂度（av-rule-3）、禁用errno（av-rule-17）、禁用setlocale（av-rule-19）、禁用setjmp/longjmp（av-rule-20）等
• JPL机构编码标准：包括禁用递归函数（jpl-rule-4）、禁用goto语句（jpl-rule-11）、检查非void函数返回值使用（jpl-rule-14）等

漏洞和缺陷检测

• 符号检查：检测禁用符号（forbidden-symbols）、缺陷符号（defective-symbols）
• 内存安全：检测使用后释放（use-after-free）、双重释放（double-free）
• 参数和返回值检查：检测不可信参数使用（untrusted-argument）、未检查返回值（must-check-value）
• 其他检查：严格性调用检查（restrictness-check）、未使用返回值警告（warn-unused）

Primus综合分析

通过Primus引擎检测多种CWE漏洞，包括：

• CWE-122（缓冲区溢出）、CWE-125（缓冲区读越界）、CWE-416（使用后释放）
• CWE-415（双重释放）、CWE-798（硬编码凭证使用）、CWE-259（硬编码密码使用）
• CWE-822（不可信指针解引用）、CWE-291（依赖IP地址认证）等14种常见漏洞

使用场景和适用范围

• 代码质量保障：对二进制文件进行编码标准合规性检查，确保符合JSF、JPL等严格编码规范
• 漏洞检测：识别二进制文件中的内存安全问题、硬编码凭证等常见安全漏洞
• 工具开发：基于提供的框架快速开发自定义二进制分析工具，并共享到社区
• 学术研究：作为二进制分析平台，支持相关领域的研究和实验

安装方法

前置条件

• 系统需安装opam 2.x包管理器
• 激活opam环境：

  bash
  eval $(opam env)
  

安装所有工具

bash
make
make install

安装特定工具

指定工具名称安装（以primus-checks为例）：

bash
make TARGET=primus-checks
make install TARGET=primus-checks

使用方法

运行工具

工具以BAP recipes形式打包，通过--recipe选项运行：

bash
bap ./目标二进制文件 --recipe=工具名称

示例：运行av-rule-3检查函数圈复杂度

bash
bap ./test.exe --recipe=av-rule-3

查看工具描述

使用--show-recipe选项获取工具详细说明：

bash
bap --show-recipe=工具名称

示例：查看av-rule-3描述

bash
bap --show-recipe=av-rule-3

列出所有工具

使用--list-recipes选项查看可用工具列表：

bash
bap --list-recipes

工具开发指南

创建新工具步骤

1. 克隆仓库：

   bash
   git clone https://github.com/BinaryAnalysisPlatform/bap-toolkit.git
   cd bap-toolkit
   

2. 创建工具目录：

   bash
   mkdir 工具名称
   cd 工具名称
   

3. 创建recipe.scm文件（工具入口点），示例：

   scheme
   ; 转储二进制文件的汇编和BIR格式
   (option dump asm:out.asm)
   (option dump bir:out.bir)
   

4. 安装并运行工具：

   bash
   make TARGET=工具名称
   make install TARGET=工具名称
   bap ./测试文件 --recipe=工具名称
   

Recipe文件语法

Recipe文件由一系列recipe项组成，支持以下类型：

• option：定义BAP命令行选项

  scheme
  ; 格式：(option 选项名 参数1 参数2 ...)
  (option run-entry-points malloc calloc free)
  ; 会被转换为：--run-entry-points=malloc,calloc,free
  

• parameter：定义可配置参数

  scheme
  ; 格式：(parameter 参数名 默认值 描述)
  (parameter depth 128 "分析的最大深度")
  (option analysis-depth $depth) ; 使用参数
  

• extend：引入其他recipe（类似#include）

  scheme
  ; 格式：(extend 其他recipe名称)
  (extend base-analysis)
  

结果查看

BAP Toolkit对https://github.com/BinaryAnalysisPlatform/bap-artifacts%E7%9A%84%E6%A3%80%E6%9F%A5%E7%BB%93%E6%9E%9C%E5%8F%AF%E9%80%9A%E8%BF%87http://htmlpreview.github.io/?https://github.com/BinaryAnalysisPlatform/bap-toolkit/blob/master/results.html%E6%9F%A5%E7%9C%8B%E3%80%82

贡献指南

欢迎通过Pull Request贡献新工具，社区鼓励开发者fork仓库、实现分析工具并共享回社区，PR将被无疑问接受。