RetroWrite开发者指南：如何创建自定义检测pass扩展二进制重写功能

RetroWrite开发者指南：如何创建自定义检测pass扩展二进制重写功能

【免费下载链接】retrowriteRetroWrite -- Retrofitting compiler passes through binary rewriting项目地址: https://gitcode.com/gh_mirrors/re/retrowrite

RetroWrite是一款强大的静态二进制重写工具，支持x64和aarch64架构，通过符号化技术实现无源码的二进制插桩，为开发者提供了灵活高效的二进制分析与改造能力。本指南将详细介绍如何为RetroWrite创建自定义检测pass，以扩展其二进制重写功能。

自定义检测pass的核心价值

自定义检测pass是RetroWrite最强大的扩展机制之一，它允许开发者在不修改核心框架的情况下，实现特定的二进制分析和转换逻辑。通过创建自定义pass，您可以：

• 实现特定领域的安全检测逻辑
• 添加自定义的代码覆盖率追踪
• 开发专有的二进制优化技术
• 构建定制化的漏洞利用防护机制

RetroWrite的pass架构设计遵循模块化原则，所有检测逻辑都被封装在独立的pass中，位于项目的rwtools_x64和rwtools_arm64目录下，分别对应x64和ARM64架构的工具集。

开发环境准备

在开始编写自定义pass之前，请确保您的开发环境已正确配置：

1. 克隆RetroWrite仓库：

   git clone https://gitcode.com/gh_mirrors/re/retrowrite

2. 安装依赖项：

   cd retrowrite pip install -r requirements.txt

3. 熟悉项目结构，特别是以下关键目录：

   • librw_x64/和librw_arm64/：核心二进制加载、解析和重写逻辑
   • rwtools_x64/和rwtools_arm64/：现有检测pass实现
   • demos/：包含各种使用示例，可用于测试自定义pass

自定义pass的基本结构

每个RetroWrite检测pass都是一个独立的Python模块，位于对应架构的rwtools目录下。一个典型的pass模块包含以下核心组件：

1. 模块结构

以下是一个基本的pass模块结构示例：

rwtools_x64/ └── my_custom_pass/ ├── __init__.py ├── instrument.py └── snippets.py # 可选，包含汇编代码片段

2. 核心类与方法

每个pass需要实现特定的接口，以便RetroWrite框架能够加载和执行它。关键组件包括：

• Instrumenter类：实现主要的插桩逻辑
• instrument_function()方法：对单个函数进行插桩
• instrument_instruction()方法：对单个指令进行插桩（可选）

创建自定义pass的详细步骤

步骤1：创建pass目录和文件

首先，在对应架构的rwtools目录下创建新的pass目录。以x64架构为例：

mkdir -p rwtools_x64/my_custom_pass touch rwtools_x64/my_custom_pass/__init__.py touch rwtools_x64/my_custom_pass/instrument.py

步骤2：实现Instrumenter类

在instrument.py中实现核心插桩逻辑。以下是一个基本框架：

from librw_x64.container import Container from librw_x64.rw import Rewriter class MyCustomInstrumenter: def __init__(self, container: Container, rewriter: Rewriter): self.container = container self.rewriter = rewriter # 初始化自定义配置和状态 def instrument_function(self, function): """对函数进行插桩处理""" # 遍历函数的所有指令 for instr in function.cache: # 实现自定义插桩逻辑 self._instrument_instruction(function, instr) def _instrument_instruction(self, function, instr): """对单个指令进行插桩""" # 检查指令类型并决定是否插桩 if self._should_instrument(instr): # 添加自定义插桩代码 self._add_instrumentation(function, instr) def _should_instrument(self, instr): """决定是否对指令进行插桩""" # 实现自定义过滤逻辑 return True # 示例：对所有指令插桩 def _add_instrumentation(self, function, instr): """添加插桩代码""" # 创建插桩指令 instrumentation = self._generate_instrumentation_code(instr) # 将插桩代码添加到指令之后 instr.instrument_after(instrumentation) def _generate_instrumentation_code(self, instr): """生成插桩用的汇编代码""" # 实现汇编代码生成逻辑 from librw_x64.util.instrumentation import InstrumentedInstruction return InstrumentedInstruction("\tnop\n") # 示例：添加nop指令

步骤3：注册pass

在__init__.py中注册您的pass，使RetroWrite能够发现它：

from .instrument import MyCustomInstrumenter def get_instrumenter(container, rewriter): return MyCustomInstrumenter(container, rewriter)

步骤4：实现插桩逻辑

根据您的需求实现具体的插桩逻辑。以下是几个常见场景的实现思路：

示例1：基本块计数

实现一个简单的基本块计数器，在每个基本块入口处添加计数逻辑：

def instrument_function(self, function): # 在函数开始处初始化计数器 init_code = """ mov r10, qword ptr [rip + basic_block_count] inc r10 mov qword ptr [rip + basic_block_count], r10 """ function.cache[0].instrument_before(InstrumentedInstruction(init_code)) # 为每个基本块添加计数逻辑 for bb_start in function.bbstarts: # 找到基本块的第一条指令 for idx, instr in enumerate(function.cache): if instr.address == bb_start: # 添加计数代码 count_code = """ mov r10, qword ptr [rip + basic_block_count] inc r10 mov qword ptr [rip + basic_block_count], r10 """ instr.instrument_before(InstrumentedInstruction(count_code)) break

示例2：内存访问跟踪

跟踪所有内存访问操作：

def _should_instrument(self, instr): # 检查指令是否访问内存 for op in instr.cs.operands: if op.type == CS_OP_MEM: return True return False def _generate_instrumentation_code(self, instr): # 生成内存访问跟踪代码 mem_access_code = f""" # 记录内存访问地址: 0x{instr.address:x} mov rdi, {instr.address} call trace_memory_access """ return InstrumentedInstruction(mem_access_code)

步骤5：测试自定义pass

创建自定义pass后，使用RetroWrite的命令行工具测试它：

retrowrite -m my_custom_pass input_binary output.s gcc output.s -o instrumented_binary

您可以使用项目中的示例程序进行测试，例如demos/user_demo/stack.c：

# 编译示例程序 cd demos/user_demo make stack # 使用自定义pass插桩 retrowrite -m my_custom_pass stack stack_instrumented.s # 汇编生成可执行文件 gcc stack_instrumented.s -o stack_instrumented # 运行测试 ./stack_instrumented

高级技巧与最佳实践

1. 利用现有pass作为参考

RetroWrite提供了多个成熟的pass实现，您可以参考它们来实现更复杂的功能：

• AddressSanitizer：rwtools_x64/asan/- 内存安全检测
• 代码覆盖率：rwtools_x64/jumparound/- 控制流混淆
• 内核插桩：rwtools_x64/kasan/- 内核内存安全检测

2. 处理指令依赖和寄存器冲突

插桩代码可能会修改寄存器状态，影响原始程序执行。使用RetroWrite提供的寄存器分析工具避免这种情况：

from librw_x64.analysis.register import RegisterAnalysis def _add_instrumentation(self, function, instr): # 分析指令使用的寄存器 ra = RegisterAnalysis(function, instr) # 获取可用的临时寄存器 temp_reg = ra.get_available_register() # 使用临时寄存器进行插桩 instrumentation = f"\tmov {temp_reg}, 0x1234\n" instr.instrument_after(InstrumentedInstruction(instrumentation))

3. 性能优化

大量插桩可能会显著影响程序性能。以下是一些优化建议：

• 选择性插桩：只对关键指令或函数进行插桩
• 批量插桩：在基本块级别而非指令级别插桩
• 高效插桩代码：使用最少的指令实现所需功能
• 利用缓存：缓存分析结果以加速多次插桩

4. 调试技巧

调试二进制插桩代码可能具有挑战性。以下技巧可以帮助您：

• 使用-v选项启用详细输出：retrowrite -v -m my_pass ...
• 在插桩代码中添加调试输出
• 使用GDB逐步执行插桩后的二进制文件
• 利用RetroWrite的日志工具：from librw_x64.util.logging import debug, info, critical

常见问题解决

Q: 我的pass没有被RetroWrite识别，该怎么办？

A: 确保您的pass模块结构正确，并且在__init__.py中实现了get_instrumenter函数。检查pass目录是否位于正确的rwtools子目录下，并确保模块名称不与现有pass冲突。

Q: 插桩后程序崩溃，如何定位问题？

A: 首先检查插桩代码是否正确保存和恢复了寄存器状态。使用-v选项运行RetroWrite，查看是否有警告或错误信息。尝试使用GDB运行插桩后的程序，定位崩溃位置。

Q: 如何处理复杂的控制流结构，如跳转表？

A: RetroWrite提供了对跳转表的支持。您可以在Function类中找到switches属性，它包含了函数中所有跳转表的信息。参考librw_arm64/container.py中的fix_jmptbl_size方法了解如何处理跳转表。

总结

创建自定义检测pass是扩展RetroWrite功能的强大方式，它允许您在不修改核心框架的情况下实现特定的二进制分析和转换逻辑。通过遵循本文介绍的步骤，您可以开发出功能强大的自定义pass，为二进制安全分析、漏洞检测和程序优化提供有力支持。

RetroWrite的模块化设计使得pass开发变得简单而灵活，无论是简单的指令计数还是复杂的内存安全检测，都可以通过自定义pass实现。希望本指南能够帮助您快速入门RetroWrite的pass开发，并开发出创新的二进制分析工具。

【免费下载链接】retrowriteRetroWrite -- Retrofitting compiler passes through binary rewriting项目地址: https://gitcode.com/gh_mirrors/re/retrowrite