crytic/slither
GitHub: crytic/slither
Slither 是一款专为 Solidity 和 Vyper 智能合约设计的静态分析框架，能以极低误报率快速检测漏洞并辅助代码审查。
Stars: 6148 | Forks: 1087
# [Slither，智能合约静态分析器](https://crytic.github.io/slither/slither.html)
[](https://github.com/crytic/slither/actions?query=workflow%3ACI)
[](https://crytic.github.io/slither/slither.html)
[](https://github.com/crytic/slither/wiki/SlithIR)
**Slither** 是一个用 Python3 编写的 Solidity & Vyper 静态分析框架。它运行一套漏洞检测器，打印有关合约详情的可视化信息，并提供一个 API 以轻松编写自定义分析。Slither 使开发者能够发现漏洞，增强对代码的理解，并快速原型化自定义分析。
* [功能特性](#features)
* [用法](#usage)
* [如何安装](#how-to-install)
* [使用 uv（推荐）](#using-uv-recommended)
* [使用 Pip](#using-pip)
* [使用 Git](#using-git-development)
* [使用 Docker](#using-docker)
* [集成](#integration)
* [检测器](#detectors)
* [打印机](#printers)
* [快速审查打印机](#quick-review-printers)
* [深度审查打印机](#in-depth-review-printers)
* [工具](#tools)
* [API 文档](#api-documentation)
* [获取帮助](#getting-help)
* [常见问题](#faq)
* [许可证](#license)
* [出版物](#publications)
* [Trail of Bits 出版物](#trail-of-bits-publication)
* [外部出版物](#external-publications)
## 功能特性
* 检测有漏洞的 Solidity 代码，具有低误报率（参见[战利品](./trophies.md)列表）
* 识别错误条件在源代码中发生的位置
* 轻松集成到持续集成和 Hardhat/Foundry 构建中
* 内置“打印机”快速报告关键合约信息
* Detector API 用于用 Python 编写自定义分析
* 能够分析用 Solidity >= 0.4 编写的合约
* 中间表示（[SlithIR](https://github.com/crytic/slither/wiki/SlithIR））实现简单、高精度的分析
* 正确解析 99.9% 的所有公开 Solidity 代码
* 每个合约的平均执行时间少于 1 秒
* 在 [CI](https://github.com/marketplace/actions/slither-action) 中与 Github 的代码扫描集成
* 支持 Vyper 智能合约
## 用法
在 Hardhat/Foundry/Dapp/Brownie 应用程序上运行 Slither：
```
slither .
```
如果你的项目有依赖项，这是首选选项，因为 Slither 依赖底层编译框架来编译源代码。
但是，你可以在不导入依赖项的单个文件上运行 Slither：
```
slither tests/uninitialized.sol
```
## 如何安装
### 使用 uv（推荐）
[uv](https://github.com/astral-sh/uv) 是一个快速的 Python 包管理器，速度比 pip 快 10-100 倍。
```
# 如尚未安装请先安装 uv
curl -LsSf https://astral.sh/uv/install.sh | sh
# 将 slither 作为工具安装
uv tool install slither-analyzer
# 或者在不安装的情况下运行 slither
uvx slither-analyzer
```
升级：
```
uv tool upgrade slither-analyzer
```
### 使用 Pip
```
python3 -m pip install slither-analyzer
```
升级：
```
python3 -m pip install --upgrade slither-analyzer
```
### 使用 Brew
```
brew install slither-analyzer
```
### 使用 Git（开发版）
```
git clone https://github.com/crytic/slither.git && cd slither
# 作为可编辑模式安装以进行开发
uv tool install -e .
# 或者使用 uv run 进行测试而无需安装
uv run slither
```
`-e` 标志以可编辑模式安装，这意味着对源代码的更改会立即生效，无需重新安装。
### 使用 Docker
使用 [`eth-security-toolbox`](https://github.com/crytic/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 action 集成，请使用 [slither-action](https://github.com/marketplace/actions/slither-action)。
* 对于 pre-commit 集成，请使用（将 `$GIT_TAG` 替换为真实标签）
- repo: https://github.com/crytic/slither
rev: $GIT_TAG
hooks:
- id: slither
* 要生成 Markdown 报告，请使用 `slither [target] --checklist`。
* 要生成带有 GitHub 源代码高亮的 Markdown，请使用 `slither [target] --checklist --markdown-root https://github.com/ORG/REPO/blob/COMMIT/`（替换 `ORG`、`REPO`、`COMMIT`）
## 检测器
编号 | 检测器 | 检测内容 | 影响 | 置信度
--- | --- | --- | --- | ---
1 | `abiencoderv2-array` | [存储 abiencoderv2 数组](https://github.com/crytic/slither/wiki/Detector-Documentation#storage-abiencoderv2-array) | 高 | 高
2 | `arbitrary-send-erc20` | [transferFrom 使用任意 `from`](https://github.com/crytic/slither/wiki/Detector-Documentation#arbitrary-from-in-transferfrom) | 高 | 高
3 | `array-by-reference` | [按值修改存储数组](https://github.com/crytic/slither/wiki/Detector-Documentation#modifying-storage-array-by-value) | 高 | 高
4 | `encode-packed-collision` | [ABI encodePacked 冲突](https://github.com/crytic/slither/wiki/Detector-Documentation#abi-encodePacked-collision) | 高 | 高
5 | `incorrect-shift` | [移位指令中的参数顺序不正确。](https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-shift-in-assembly) | 高 | 高
6 | `multiple-constructors` | [多个构造函数方案](https://github.com/crytic/slither/wiki/Detector-Documentation#multiple-constructor-schemes) | 高 | 高
7 | `name-reused` | [合约名称被重用](https://github.com/crytic/slither/wiki/Detector-Documentation#name-reused) | 高 | 高
8 | `protected-vars` | [检测到未受保护的变量](https://github.com/crytic/slither/wiki/Detector-Documentation#protected-variables) | 高 | 高
9 | `public-mappings-nested` | [具有嵌套变量的公共映射](https://github.com/crytic/slither/wiki/Detector-Documentation#public-mappings-with-nested-variables) | 高 | 高
10 | `rtlo` | [使用了从右到左覆盖控制字符](https://github.com/crytic/slither/wiki/Detector-Documentation#right-to-left-override-character) | 高 | 高
11 | `shadowing-state` | [状态变量遮蔽](https://github.com/crytic/slither/wiki/Detector-Documentation#state-variable-shadowing) | 高 | 高
12 | `suicidal` | [允许任何人销毁合约的函数](https://github.com/crytic/slither/wiki/Detector-Documentation#suicidal) | 高 | 高
13 | `uninitialized-state` | [未初始化的状态变量](https://github.com/crytic/slither/wiki/Detector-Documentation#uninitialized-state-variables) | 高 | 高
14 | `uninitialized-storage` | [未初始化的存储变量](https://github.com/crytic/slither/wiki/Detector-Documentation#uninitialized-storage-variables) | 高 | 高
15 | `unprotected-upgrade` | [未受保护的可升级合约](https://github.com/crytic/slither/wiki/Detector-Documentation#unprotected-upgradeable-contract) | 高 | 高
16 | `arbitrary-send-erc20-permit` | [transferFrom 在 permit 下使用任意 from](https://github.com/crytic/slither/wiki/Detector-Documentation#arbitrary-from-in-transferfrom-used-with-permit) | 高 | 中
17 | `arbitrary-send-eth` | [向任意目的地发送 Ether 的函数](https://github.com/crytic/slither/wiki/Detector-Documentation#functions-that-send-ether-to-arbitrary-destinations) | 高 | 中
18 | `controlled-array-length` | [受污染的数组长度赋值](https://github.com/crytic/slither/wiki/Detector-Documentation#array-length-assignment) | 高 | 中
19 | `controlled-delegatecall` | [受控制的 delegatecall 目标](https://github.com/crytic/slither/wiki/Detector-Documentation#controlled-delegatecall) | 高 | 中
20 | `delegatecall-loop` | [在循环中使用 `delegatecall` 的应付函数](https://github.com/crytic/slither/wiki/Detector-Documentation/#payable-functions-using-delegatecall-inside-a-loop) | 高 | 中
21 | `incorrect-exp` | [不正确的求幂](https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-exponentiation) | 高 | 中
22 | `incorrect-return` | [如果在汇编模式下错误地使用了 `return`。](https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-return-in-assembly) | 高 | 中
23 | `msg-value-loop` | [循环中的 msg.value](https://github.com/crytic/slither/wiki/Detector-Documentation/#msgvalue-inside-a-loop) | 高 | 中
24 | `reentrancy-eth` | [重入漏洞（以太币被盗）](https://github.com/crytic/slither/wiki/Detector-Documentation#reentrancy-vulnerabilities) | 高 | 中
25 | `reentrancy-balance` | [导致余额检查过期的重入漏洞](https://github.com/crytic/slither/wiki/Detector-Documentation#reentrancy-vulnerabilities-4) | 高 | 中
26 | `return-leave` | [如果使用了 `return` 而不是 `leave`。](https://github.com/crytic/slither/wiki/Detector-Documentation#return-instead-of-leave-in-assembly) | 高 | 中
27 | `storage-array` | [有符号存储整数数组编译器错误](https://github.com/crytic/slither/wiki/Detector-Documentation#storage-signed-integer-array) | 高 | 中
28 | `unchecked-transfer` | [未检查的代币转账](https://github.com/crytic/slither/wiki/Detector-Documentation#unchecked-transfer) | 高 | 中
29 | `weak-prng` | [弱 PRNG](https://github.com/crytic/slither/wiki/Detector-Documentation#weak-PRNG) | 高 | 中
30 | `domain-separator-collision` | [检测具有与 EIP-2612 的 DOMAIN_SEPARATOR() 签名冲突的函数的 ERC20 代币](https://github.com/crytic/slither/wiki/Detector-Documentation#domain-separator-collision) | 中 | 高
31 | `enum-conversion` | [检测危险的枚举转换](https://github.com/crytic/slither/wiki/Detector-Documentation#dangerous-enum-conversion) | 中 | 高
32 | `erc20-interface` | [不正确的 ERC20 接口](https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-erc20-interface) | 中 | 高
33 | `erc721-interface` | [不正确的 ERC721 接口](https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-erc721-interface) | 中 | 高
34 | `incorrect-equality` | [危险的严格相等](https://github.com/crytic/slither/wiki/Detector-Documentation#dangerous-strict-equalities) | 中 | 高
35 | `locked-ether` | [锁定以太币的合约](https://github.com/crytic/slither/wiki/Detector-Documentation#contracts-that-lock-ether) | 中 | 高
36 | `mapping-deletion` | [删除包含结构的映射](https://github.com/crytic/slither/wiki/Detector-Documentation#deletion-on-mapping-containing-a-structure) | 中 | 高
37 | `pyth-deprecated-functions` | [检测 Pyth 已弃用的函数](https://github.com/crytic/slither/wiki/Detector-Documentation#pyth-deprecated-functions) | 中 | 高
38 | `pyth-unchecked-confidence` | [检测未检查 Pyth 价格置信度的情况](https://github.com/crytic/slither/wiki/Detector-Documentation#pyth-unchecked-confidence-level) | 中 | 高
39 | `pyth-unchecked-publishtime` | [检测未检查 Pyth 价格发布时间的情况](https://github.com/crytic/slither/wiki/Detector-Documentation#pyth-unchecked-publishtime) | 中 | 高
40 | `shadowing-abstract` | [来自抽象合约的状态变量遮蔽](https://github.com/crytic/slither/wiki/Detector-Documentation#state-variable-shadowing-from-abstract-contracts) | 中 | 高
41 | `tautological-compare` | [将变量与自身比较总是返回真或假，具体取决于比较](https://github.com/crytic/slither/wiki/Detector-Documentation#tautological-compare) | 中 | 高
42 | `tautology` | [重言式或矛盾式](https://github.com/crytic/slither/wiki/Detector-Documentation#tautology-or-contradiction) | 中 | 高
43 | `write-after-write` | [未使用的写入](https://github.com/crytic/slither/wiki/Detector-Documentation#write-after-write) | 中 | 高
44 | `boolean-cst` | [布尔常量的误用](https://github.com/crytic/slither/wiki/Detector-Documentation#misuse-of-a-boolean-constant) | 中 | 中
45 | `chronicle-unchecked-price` | [检测未检查 Chronicle 价格的情况。](https://github.com/crytic/slither/wiki/Detector-Documentation#chronicle-unchecked-price) | 中 | 中
46 | `constant-function-asm` | [使用汇编代码的常量函数](https://github.com/crytic/slither/wiki/Detector-Documentation#constant-functions-using-assembly-code) | 中 | 中
47 | `constant-function-state` | [更改状态的常量函数](https://github.com/crytic/slither/wiki/Detector-Documentation#constant-functions-changing-the-state) | 中 | 中
48 | `divide-before-multiply` | [不精确的算术运算顺序](https://github.com/crytic/slither/wiki/Detector-Documentation#divide-before-multiply) | 中 | 中
49 | `gelato-unprotected-randomness` | [在未受保护的函数中调用 `_requestRandomness`](https://github.com/crytic/slither/wiki/Detector-Documentation#gelato-unprotected-randomness) | 中 | 中
50 | `out-of-order-retryable` | [乱序可重试交易](https://github.com/crytic/slither/wiki/Detector-Documentation#out-of-order-retryable-transactions) | 中 | 中
51 | `reentrancy-no-eth` | [重入漏洞（无以太币被盗）](https://github.com/crytic/slither/wiki/Detector-Documentation#reentrancy-vulnerabilities-1) | 中 | 中
52 | `reused-constructor` | [重用的基础构造函数](https://github.com/crytic/slither/wiki/Detector-Documentation#reused-base-constructors) | 中 | 中
53 | `tx-origin` | [`tx.origin` 的危险使用](https://github.com/crytic/slither/wiki/Detector-Documentation#dangerous-usage-of-txorigin) | 中 | 中
54 | `unchecked-lowlevel` | [未检查的低级调用](https://github.com/crytic/slither/wiki/Detector-Documentation#unchecked-low-level-calls) | 中 | 中
55 | `unchecked-send` | [未检查的发送](https://github.com/crytic/slither/wiki/Detector-Documentation#unchecked-send) | 中 | 中
56 | `uninitialized-local` | [未初始化的局部变量](https://github.com/crytic/slither/wiki/Detector-Documentation#uninitialized-local-variables) | 中 | 中
57 | `unused-return` | [未使用的返回值](https://github.com/crytic/slither/wiki/Detector-Documentation#unused-return) | 中 | 中
58 | `chainlink-feed-registry` | [检测使用 chainlink feed registry 的情况](https://github.com/crytic/slither/wiki/Detector-Documentation#chainlink-feed-registry-usage) | 低 | 高
59 | `incorrect-modifier` | [可能返回默认值的修饰符](https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-modifier) | 低 | 高
60 | `optimism-deprecation` | [检测使用已弃用的 Optimism 预部署或函数的情况。](https://github.com/crytic/slither/wiki/Detector-Documentation#optimism-deprecated-predeploy-or-function) | 低 | 高
61 | `shadowing-builtin` | [内置符号遮蔽](https://github.com/crytic/slither/wiki/Detector-Documentation#builtin-symbol-shadowing) | 低 | 高
62 | `shadowing-local` | [局部变量遮蔽](https://github.com/crytic/slither/wiki/Detector-Documentation#local-variable-shadowing) | 低 | 高
63 | `uninitialized-fptr-cst` | [构造函数中未初始化的函数指针调用](https://github.com/crytic/slither/wiki/Detector-Documentation#uninitialized-function-pointers-in-constructors) | 低 | 高
64 | `variable-scope` | [在声明之前使用的局部变量](https://github.com/crytic/slither/wiki/Detector-Documentation#pre-declaration-usage-of-local-variables) | 低 | 高
65 | `void-cst` | [构造函数调用未实现](
[](https://github.com/crytic/slither/actions?query=workflow%3ACI)
[](https://crytic.github.io/slither/slither.html)
[](https://github.com/crytic/slither/wiki/SlithIR)
**Slither** 是一个用 Python3 编写的 Solidity & Vyper 静态分析框架。它运行一套漏洞检测器，打印有关合约详情的可视化信息，并提供一个 API 以轻松编写自定义分析。Slither 使开发者能够发现漏洞，增强对代码的理解，并快速原型化自定义分析。
* [功能特性](#features)
* [用法](#usage)
* [如何安装](#how-to-install)
* [使用 uv（推荐）](#using-uv-recommended)
* [使用 Pip](#using-pip)
* [使用 Git](#using-git-development)
* [使用 Docker](#using-docker)
* [集成](#integration)
* [检测器](#detectors)
* [打印机](#printers)
* [快速审查打印机](#quick-review-printers)
* [深度审查打印机](#in-depth-review-printers)
* [工具](#tools)
* [API 文档](#api-documentation)
* [获取帮助](#getting-help)
* [常见问题](#faq)
* [许可证](#license)
* [出版物](#publications)
* [Trail of Bits 出版物](#trail-of-bits-publication)
* [外部出版物](#external-publications)
## 功能特性
* 检测有漏洞的 Solidity 代码，具有低误报率（参见[战利品](./trophies.md)列表）
* 识别错误条件在源代码中发生的位置
* 轻松集成到持续集成和 Hardhat/Foundry 构建中
* 内置“打印机”快速报告关键合约信息
* Detector API 用于用 Python 编写自定义分析
* 能够分析用 Solidity >= 0.4 编写的合约
* 中间表示（[SlithIR](https://github.com/crytic/slither/wiki/SlithIR））实现简单、高精度的分析
* 正确解析 99.9% 的所有公开 Solidity 代码
* 每个合约的平均执行时间少于 1 秒
* 在 [CI](https://github.com/marketplace/actions/slither-action) 中与 Github 的代码扫描集成
* 支持 Vyper 智能合约
## 用法
在 Hardhat/Foundry/Dapp/Brownie 应用程序上运行 Slither：
```
slither .
```
如果你的项目有依赖项，这是首选选项，因为 Slither 依赖底层编译框架来编译源代码。
但是，你可以在不导入依赖项的单个文件上运行 Slither：
```
slither tests/uninitialized.sol
```
## 如何安装
### 使用 uv（推荐）
[uv](https://github.com/astral-sh/uv) 是一个快速的 Python 包管理器，速度比 pip 快 10-100 倍。
```
# 如尚未安装请先安装 uv
curl -LsSf https://astral.sh/uv/install.sh | sh
# 将 slither 作为工具安装
uv tool install slither-analyzer
# 或者在不安装的情况下运行 slither
uvx slither-analyzer 标签：DeFi安全, LNA, Python, SE防防, Slither, SlithIR, Solidity, Trail of Bits, Vyper, Web3安全, 云安全监控, 以太坊, 区块链安全, 开发安全, 无后门, 智能合约审计, 智能合约漏洞, 逆向工具, 静态代码分析器, 静态分析