智能合约与以太坊 / 系统课时
迁移失败序列到 Forge 复测
迁移失败序列到 Forge 复测
Echidna 找到违反安全属性的调用序列后,需要将反例转换为可重复执行的 Forge 测试。本篇通过一个存在重复领取漏洞的合约,演示如何读取反例、还原交易顺序、固定调用上下文,并使用 Forge 确认缺陷及验证修复效果。
学习目标
- 识别 Echidna 反例中的函数、参数、调用者和执行顺序。
- 将失败序列迁移为可运行的 Forge 回归测试。
- 对照两套工具的测试结果,区分真实漏洞与环境差异。
读取 Echidna 的失败序列
Echidna 是针对以太坊智能合约的模糊测试工具。它可以连续调用合约函数,并检查名称以 `echidna_` 开头、返回 `bool` 的安全属性。当某次执行使属性返回 `false` 时,Echidna 会报告失败并尝试缩减调用序列。
先准备一个最小合约,保存为 Foundry 项目中的 `src/OneTimeGate.sol`。该合约允许用户开启领取功能,但故意遗漏了防止重复领取的检查。
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
contract OneTimeGate {
bool public opened;
uint256 public claims;
function open() external {
opened = true;
}
function claim() external {
require(opened, "not opened");
// 漏洞:没有检查是否已经领取过
claims += 1;
}
function echidna_claim_once() external view returns (bool) {
return claims <= 1;
}
}这里的安全属性要求累计成功领取次数不能超过一次。对于演示合约,最短的典型失败序列为:
- 调用 `open()`,令 `opened` 变为 `true`。
- 第一次调用 `claim()`,令 `claims` 变为 `1`。
- 第二次调用 `claim()`,令 `claims` 变为 `2`。
- 检查 `echidna_claim_once()`,得到 `false`。
在已经安装 Echidna 和 Foundry 的项目根目录执行:
echidna src/OneTimeGate.sol --contract OneTimeGate --test-mode property预期结果:Echidna 找到 `echidna_claim_once` 的失败反例,报告中包含导致属性失败的函数调用。具体参数、序列长度和显示格式可能随 Echidna 版本、随机种子和缩减过程变化,不应把演示序列当作工具必然逐字输出的结果。
对于实际项目,应当保存原始反例,并逐项记录以下信息:
| 信息 | 需要保留的内容 |
|---|---|
| 调用顺序 | 每笔交易的执行先后 |
| 目标合约 | 被调用的合约和实际部署地址 |
| 调用数据 | 函数签名、ABI 参数或原始 calldata |
| 调用上下文 | `msg.sender`、`msg.value` |
| 环境状态 | 部署参数、初始余额、区块号、时间戳 |
| 失败属性 | 属性名称及失败时的实际状态 |
如果启用了 Echidna 的 `corpusDir` 配置,还可以检查该目录中的测试语料。不同版本和测试模式生成的文件内容可能不同,不要假设每个失败反例都会自动保存成可直接供 Forge 执行的脚本。
在 Forge 中重建交易顺序
迁移反例时,优先编写确定性单元测试,而不是重新调用 Forge 的随机模糊测试。这样可以固定交易顺序,使问题不再依赖随机种子和搜索过程。
在已有 Foundry 项目中,新建 `test/OneTimeGateReplay.t.sol`。示例依赖标准 `forge-std` 测试库,使用 Forge 的 `Test` 基类部署合约并检查属性。
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {Test} from "forge-std/Test.sol";
import {OneTimeGate} from "../src/OneTimeGate.sol";
contract OneTimeGateReplayTest is Test {
OneTimeGate internal gate;
address internal alice = address(0xA11CE);
function setUp() public {
gate = new OneTimeGate();
}
function testReplayEchidnaSequence() public {
// 固定调用者,按反例顺序执行交易
vm.startPrank(alice);
gate.open();
gate.claim();
gate.claim();
vm.stopPrank();
// 与 Echidna 检查同一个安全属性
assertTrue(gate.echidna_claim_once(), "claim repeated");
}
}这里的 `vm.startPrank(alice)` 会让后续外部调用以 Alice 的身份执行,直到调用 `vm.stopPrank()`。如果原始反例包含不同发送者,应改为分别使用 `vm.prank(sender)`,不能将全部交易合并成一个调用者。
执行指定测试:
forge test --match-test testReplayEchidnaSequence -vv预期结果:测试失败,失败信息包含 `claim repeated`,说明安全属性返回了 `false`。输出中的测试耗时、Gas 和编译信息会随运行环境变化。
需要特别区分两种失败:如果 Forge 因预期的属性断言失败,说明成功复现了违反安全属性的状态;如果交易提前 `revert`、部署失败或者测试无法编译,则尚未证明同一个漏洞已经复现。
还原复杂反例的执行上下文
真实反例可能涉及多个账户、带参数的函数、ETH 转账以及随时间变化的状态。只复制函数名通常不够,还必须恢复影响结果的上下文。
Foundry 提供相应的测试控制接口:
| 反例信息 | Forge 复测方式 |
|---|---|
| 不同调用者 | `vm.prank(address)` |
| 连续相同调用者 | `vm.startPrank(address)` 和 `vm.stopPrank()` |
| 账户初始 ETH 余额 | `vm.deal(address, amount)` |
| 指定区块时间戳 | `vm.warp(timestamp)` |
| 指定区块号 | `vm.roll(blockNumber)` |
| 交易附带 ETH | 对 payable 函数使用 `{value: amount}` |
| 原始 calldata | 使用 `address(target).call(data)` |
例如,反例记录的调用者是 `0xA11CE`,交易包含 `0.5 ether`,复测前应确保该账户拥有足够余额,并通过目标函数的 payable 接口传入相同金额。不能仅使用 `vm.deal` 增加余额就认为已经还原了 `msg.value`。
对于通过 ABI 解码获得的函数调用,优先使用类型明确的 Solidity 函数调用。只有在函数选择器、低级调用行为或原始 calldata 本身与漏洞有关时,才使用低级 `call`。
如果反例涉及主网状态,应固定相同的链、Fork 区块和合约部署状态。时间戳、区块号、账户余额、代理实现地址及外部依赖都会影响复现结果。
比较 Echidna 与 Forge 的检查结果
两个工具的测试形式不同,但可以针对同一个性质给出相互印证的结果。
在本例中,Echidna 检查 `echidna_claim_once()` 是否始终返回 `true`,而 Forge 在执行固定调用序列后,通过 `assertTrue` 对同一属性进行断言。
| 检查项目 | Echidna | Forge 回归测试 |
|---|---|---|
| 输入来源 | 自动生成调用序列 | 固定失败序列 |
| 属性表达 | 返回 `bool` 的属性函数 | `assertTrue` 断言 |
| 失败定位 | 搜索并缩减反例 | 固定步骤直接复现 |
| 可重复性 | 依赖搜索配置与随机过程 | 输入和环境固定后可重复 |
| 主要用途 | 发现未知失败路径 | 验证根因和防止回归 |
对照时应先检查以下三个条件:
- 两次测试是否使用相同的合约代码、编译设置和初始状态。
- 调用顺序、参数、发送者以及区块环境是否一致。
- 失败时是否确实违反同一个业务属性,而不是遇到不同的断言或异常。
若 Echidna 报告失败,而 Forge 复测通过,首先检查是否漏掉某笔状态变更交易。其次检查 `msg.sender`、`msg.value`、时间戳和部署初始状态。最后确认是否使用了不同版本的合约或依赖。
如果这些条件相同,固定反例仍无法重现,则应重新分析原始失败记录,而不是直接判断 Echidna 误报。
修复漏洞并保留回归测试
找到根因后,应保留原来的失败序列作为回归测试,再修复合约。对于本例,修复方式是增加一次性领取状态,并在成功领取后立即更新状态。
将 `src/OneTimeGate.sol` 中的 `claim()` 替换为以下实现,同时在合约状态变量区域添加 `bool public claimed;`。
片段示例:依赖前面定义的 `OneTimeGate` 合约和 `opened` 状态变量。
function claim() external {
require(opened, "not opened");
require(!claimed, "already claimed");
// 在外部交互之前更新领取状态
claimed = true;
claims += 1;
}这个修复会使第二次 `claim()` 发生预期回滚。因此,原测试必须调整为既检查重复领取被拒绝,又检查属性未被破坏。
片段示例:替换 `OneTimeGateReplayTest` 内的同名测试方法,继续使用原有 `setUp()`、`gate` 和 `alice`。
function testReplayEchidnaSequence() public {
vm.startPrank(alice);
gate.open();
gate.claim();
// 第二次领取必须被明确拒绝
vm.expectRevert("already claimed");
gate.claim();
vm.stopPrank();
assertEq(gate.claims(), 1);
assertTrue(gate.echidna_claim_once());
}重新执行:
forge test --match-test testReplayEchidnaSequence -vv预期结果:测试通过。`vm.expectRevert` 确认第二次调用被拒绝,而后面的断言确认成功领取次数仍为 `1`,安全属性继续成立。
随后使用相同的 Echidna 配置重新运行属性测试。修复后应当观察到本例不再出现重复领取反例,但一次模糊测试未发现失败不等于对所有可能输入完成形式化证明。
项目验收时,应同时保存 Echidna 原始反例、Forge 固定回归测试和修复后的运行结果。这样未来升级 Solidity 编译器、修改业务合约或调整安全规则时,都能直接运行回归测试,确认已知缺陷没有重新出现。