Slither，智能合约静态分析器

加入 Empire Hacking Slack

_{- 讨论和支持}

Slither 是一个用 Python3 编写的 Solidity 和 Vyper 静态分析框架。它运行一套漏洞检测器，打印合约细节的可视化信息，并提供 API 以便轻松编写自定义分析。Slither 使开发者能够发现漏洞、增强代码理解，并快速原型化自定义分析。

• 特性
• 使用方法
• 如何安装
  • 使用 Pip
  • 使用 Git
  • 使用 Docker
  • 集成
• 检测器
• 打印器
  • 快速审查打印器
  • 深入审查打印器
• 工具
• API 文档
• 获取帮助
• 常见问题
• 许可证
• 出版物
  • Trail of Bits 出版物
  • 外部出版物

特性

• 以低误报率检测易受攻击的 Solidity 代码（参见奖杯列表）
• 在源代码中识别错误条件的发生位置
• 轻松集成到持续集成和 Hardhat/Foundry 构建中
• 内置"打印器"快速报告关键合约信息
• 检测器 API 用于用 Python 编写自定义分析
• 能够分析用 Solidity >= 0.4 编写的合约
• 中间表示（SlithIR）实现简单、高精度的分析
• 正确解析 99.9% 的公开 Solidity 代码
• 平均执行时间每个合约不到 1 秒
• 在 CI 中与 GitHub 的代码扫描集成
• 支持 Vyper 智能合约

使用方法

在 Hardhat/Foundry/Dapp/Brownie 应用程序上运行 Slither：

slither .

如果您的项目有依赖项，这是首选选项，因为 Slither 依赖于底层编译框架来编译源代码。

然而，您可以在不导入依赖项的单个文件上运行 Slither：

slither tests/uninitialized.sol

如何安装

注意
Slither 需要 Python 3.8+。 如果您不打算使用支持的编译框架之一，您需要 solc，Solidity 编译器；我们建议使用 solc-select 方便地在 solc 版本之间切换。

使用 Pip

python3 -m pip install slither-analyzer

使用 Git

git clone https://github.com/crytic/slither.git && cd slither
python3 -m pip install .

如果您更喜欢通过 git 安装 Slither，我们建议使用 Python 虚拟环境，详见开发者安装说明。

使用 Docker

使用 eth-security-toolbox Docker 镜像。它包含了我们所有的安全工具和每个主要版本的 Solidity，全部集成在一个镜像中。/home/share 将被挂载到容器中的 /share。

docker pull trailofbits/eth-security-toolbox

要在容器中共享目录：

docker run -it -v /home/share:/share trailofbits/eth-security-toolbox

集成

• 对于 GitHub 操作集成，使用 slither-action。
• 要生成 Markdown 报告，使用 slither [target] --checklist。
• 要生成带有 GitHub 源代码高亮的 Markdown，使用 slither [target] --checklist --markdown-root https://github.com/ORG/REPO/blob/COMMIT/（替换 ORG、REPO、COMMIT）

检测器

• 检测器文档以获取每个检测器的详细信息
• 检测选择以仅运行选定的检测器。默认情况下，所有检测器都会运行。
• 分类模式以过滤单个结果

打印器

快速审查打印器

• human-summary: 打印合约的人类可读摘要
• inheritance-graph: 将每个合约的继承图导出为dot文件
• contract-summary: 打印合约摘要
• loc: 统计源文件(SRC)、依赖项(DEP)和测试文件(TEST)中的总代码行数(LOC)、源代码行数(SLOC)和注释行数(CLOC)

深入审查打印器

• call-graph: 将合约的调用图导出为dot文件
• cfg: 导出每个函数的CFG
• function-summary: 打印函数摘要
• vars-and-auth: 打印被写入的状态变量和函数的授权
• not-pausable: 打印不使用whenNotPaused修饰符的函数

要运行打印器，请使用--print和以逗号分隔的打印器列表。

完整列表请参阅打印器文档。

工具

• slither-check-upgradeability: 审查基于delegatecall的可升级性
• slither-prop: 自动单元测试和属性生成
• slither-flat: 扁平化代码库
• slither-check-erc: 检查ERC合规性
• slither-format: 自动补丁生成
• slither-read-storage: 从合约中读取存储值
• slither-interface: 为合约生成接口

有关其他工具，请参阅工具文档。

联系我们以获取有关构建自定义工具的帮助。

API文档

Slither内部结构的文档可在此处获取。

获取帮助

如果您需要使用或扩展Slither的帮助，欢迎加入我们的Slack频道 (#ethereum)。

• 打印器文档描述了Slither能够为每个合约可视化的信息。

• 检测器文档描述了如何编写新的漏洞分析。

• API文档描述了可用于自定义分析的方法和对象。

• SlithIR文档描述了SlithIR中间表示。

常见问题

如何排除模拟或测试？

• 查看我们关于路径过滤的文档。

如何解决"未知文件"或编译问题？

• 由于slither需要solc AST，它必须有所有依赖项可用。如果合约有依赖项，slither contract.sol将失败。相反，在contracts/的父目录中使用slither .（当你运行ls时应该看到contracts/）。如果你有一个node_modules/文件夹，它必须与contracts/在同一目录中。要验证这个问题是否与slither有关，请运行你正在使用的框架的编译命令，例如npx hardhat compile。这必须成功运行；否则，slither的编译引擎crytic-compile无法生成AST。

许可证

Slither根据AGPLv3许可证获得许可和分发。如果你需要例外条款，请联系我们。

出版物

Trail of Bits出版物

• Slither: 智能合约静态分析框架，Josselin Feist, Gustavo Grieco, Alex Groce - WETSEB '19

外部出版物