Slither，智能合约静态分析器

加入 Empire Hacking Slack

- 讨论与支持

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

• 功能
• 使用
• 安装方法
  • 使用 uv（推荐）
  • 使用 Pip
  • 使用 Git
  • 使用 Docker
  • 集成
• Detectors
• Printers
  • 快速审查 Printers
  • 深度审查 Printers
• 工具
• API 文档
• 获取帮助
• 常见问题
• 许可证
• 出版物
  • Trail of Bits 出版物
  • 外部出版物

功能

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

使用

在 Hardhat/Foundry/Dapp/Brownie 应用程序上运行 Slither：```console slither .

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

不过，你也可以在单个不导入依赖的文件上运行 Slither：```console
slither tests/uninitialized.sol

如何安装

注意 Slither 需要 Python 3.10+。 如果您不打算使用 支持的编译框架，则需要 solc 即 Solidity 编译器；我们推荐使用 solc-select 来方便地在不同 solc 版本间切换。

使用 uv（推荐）

uv 是一个快速的 Python 包管理器，速度比 pip 快 10 到 100 倍。```console

Install uv if you haven't already

curl -LsSf https://astral.sh/uv/install.sh | sh

Install slither as a tool

uv tool install slither-analyzer

Or run slither without installation

uvx --from slither-analyzer slither

升级：```console
uv tool upgrade slither-analyzer

使用 Pip```console

python3 -m pip install slither-analyzer

要升级：```console
python3 -m pip install --upgrade slither-analyzer

使用 Brew```console

brew install slither-analyzer

### 使用 Git（开发）```bash
git clone https://github.com/crytic/slither.git && cd slither

# Install as editable for development
uv tool install -e .

# Or use uv run for testing without installation
uv run slither <target>

The -e flag installs in editable mode, meaning changes to the source code are immediately reflected without reinstalling.

使用 Docker

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

为了在容器中共享一个目录：```bash
docker run -it -v /home/share:/share trailofbits/eth-security-toolbox

集成

• 对于 GitHub Action 集成，请使用 slither-action。
• 对于 pre-commit 集成，请使用（将 $GIT_TAG 替换为实际标签） ```YAML
  • repo: https://github.com/crytic/slither rev: $GIT_TAG hooks:
    • id: slither
  root@kitploit:~

• 要生成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)。
• entry-points: 输出合约中所有改变状态的入口点函数及其变量

深入审查输出器* 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-read-storage: 从合约读取存储值
• slither-interface: 为合约生成接口

参见 工具文档 获取更多工具。

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

API 文档

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

获取帮助

欢迎访问我们的 Slack 频道 (#ethereum) 以获取使用或扩展 Slither 的帮助。

• 打印机文档 描述了 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

外部出版文章

如果你在学术工作中使用 Slither，考虑申请 Crytic $10k 研究奖。