Python Shell static-analysis solidity Ethereum
Need help with slither?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
crytic

Description

Static Analyzer for Solidity

610 Stars 149 Forks GNU Affero General Public License v3.0 2.0K Commits 126 Opened issues

Services available

Need anything else?

Slither, the Solidity source analyzer

Logo

Build Status Slack Status PyPI version

Slither is a Solidity static analysis framework written in Python 3. It runs a suite of vulnerability detectors, prints visual information about contract details, and provides an API to easily write custom analyses. Slither enables developers to find vulnerabilities, enhance their code comprehension, and quickly prototype custom analyses.

Features

  • Detects vulnerable Solidity code with low false positives
  • Identifies where the error condition occurs in the source code
  • Easily integrates into continuous integration and Truffle builds
  • Built-in 'printers' quickly report crucial contract information
  • Detector API to write custom analyses in Python
  • Ability to analyze contracts written with Solidity >= 0.4
  • Intermediate representation (SlithIR) enables simple, high-precision analyses
  • Correctly parses 99.9% of all public Solidity code
  • Average execution time of less than 1 second per contract

Bugs and Optimizations Detection

Run Slither on a Truffle/Embark/Dapp/Etherlime application:

bash
slither .

Run Slither on a single file:

bash
slither tests/uninitialized.sol

For additional configuration, see the usage documentation.

Use solc-select if your contracts require older versions of solc.

Detectors

Num

Detector What it Detects Impact Confidence
1

name-reused
Contract's name reused High High
2
rtlo
Right-To-Left-Override control character is used High High
3
shadowing-state
State variables shadowing High High
4
suicidal
Functions allowing anyone to destruct the contract High High
5
uninitialized-state
Uninitialized state variables High High
6
uninitialized-storage
Uninitialized storage variables High High
7
arbitrary-send
Functions that send ether to arbitrary destinations High Medium
8
controlled-delegatecall
Controlled delegatecall destination High Medium
9
reentrancy-eth
Reentrancy vulnerabilities (theft of ethers) High Medium
10
erc20-interface
Incorrect ERC20 interfaces Medium High
11
erc721-interface
Incorrect ERC721 interfaces Medium High
12
incorrect-equality
Dangerous strict equalities Medium High
13
locked-ether
Contracts that lock ether Medium High
14
shadowing-abstract
State variables shadowing from abstract contracts Medium High
15
tautology
Tautology or contradiction Medium High
16
boolean-cst
Misuse of Boolean constant Medium Medium
17
constant-function-asm
Constant functions using assembly code Medium Medium
18
constant-function-state
Constant functions changing the state Medium Medium
19
divide-before-multiply
Imprecise arithmetic operations order Medium Medium
20
reentrancy-no-eth
Reentrancy vulnerabilities (no theft of ethers) Medium Medium
21
tx-origin
Dangerous usage of
tx.origin
Medium Medium
22
unchecked-lowlevel
Unchecked low-level calls Medium Medium
23
unchecked-send
Unchecked send Medium Medium
24
uninitialized-local
Uninitialized local variables Medium Medium
25
unused-return
Unused return values Medium Medium
26
shadowing-builtin
Built-in symbol shadowing Low High
27
shadowing-local
Local variables shadowing Low High
28
void-cst
Constructor called not implemented Low High
29
calls-loop
Multiple calls in a loop Low Medium
30
reentrancy-benign
Benign reentrancy vulnerabilities Low Medium
31
reentrancy-events
Reentrancy vulnerabilities leading to out-of-order Events Low Medium
32
timestamp
Dangerous usage of
block.timestamp
Low Medium
33
assembly
Assembly usage Informational High
34
boolean-equal
Comparison to boolean constant Informational High
35
deprecated-standards
Deprecated Solidity Standards Informational High
36
erc20-indexed
Un-indexed ERC20 event parameters Informational High
37
low-level-calls
Low level calls Informational High
38
naming-convention
Conformance to Solidity naming conventions Informational High
39
pragma
If different pragma directives are used Informational High
40
solc-version
Incorrect Solidity version Informational High
41
unused-state
Unused state variables Informational High
42
reentrancy-unlimited-gas
Reentrancy vulnerabilities through send and transfer Informational Medium
43
too-many-digits
Conformance to numeric notation best practices Informational Medium
44
constable-states
State variables that could be declared constant Optimization High
45
external-function
Public function that could be declared as external Optimization High

See the Detectors Documentation for more information. By default, all the detectors are run.

Check out Crytic to get access to additional Slither's detectors and GitHub integration.

Printers

Quick Review Printers

In-Depth Review Printers

To run a printer, use

--print
and a comma-separated list of printers.

See the Printer documentation for the complete lists.

Tools

See the Tool documentation for additional tools.

Contact us to get help on building custom tools.

How to install

Slither requires Python 3.6+ and solc, the Solidity compiler.

Using Pip

pip3 install slither-analyzer

Using Git

git clone https://github.com/crytic/slither.git && cd slither
python3 setup.py install

We recommend using an Python virtual environment, as detailed in the Developer Installation Instructions, if you prefer to install Slither via git.

Using Docker

Use the

eth-security-toolbox
docker image. It includes all of our security tools and every major version of Solidity in a single image.

/home/share
will be mounted to
/share
in the container.
docker pull trailofbits/eth-security-toolbox

To share a directory in the container:

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

Getting Help

Feel free to stop by our Slack channel (#ethereum) for help using or extending Slither.

License

Slither is licensed and distributed under the AGPLv3 license. Contact us if you're looking for an exception to the terms.

Publications

Trail of Bits publication

External publications

If you are using Slither on an academic work, consider applying to the Crytic $10k Research Prize.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.