Static Analyzer for Solidity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Disconnect3d de529a6fe3
Verify solc binary
6 years ago
examples Add human printer example 6 years ago
plugin_example Update example.py 6 years ago
scripts Make json result more deterministic 6 years ago
slither Merge branch 'dev-improve-json' 6 years ago
tests Update naming convention to new json format 6 years ago
.gitattributes Initial public commit 6 years ago
.gitignore removed vscode folder 6 years ago
.travis.yml Add dev branch to travis 6 years ago
Dockerfile Verify solc binary 6 years ago
LICENSE Initial public commit 6 years ago
README.md Update classification of unused return value detector 6 years ago
setup.py v0.3.1 6 years ago

README.md

Slither, the Solidity source analyzer

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 comphrehension, and quickly prototype custom analyses.

Features

  • Detects vulnerable Solidity code with low false positives
  • Identifies where the error condition occurs in the source code
  • Easy integration 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

Usage

Run Slither on a Truffle application:

slither .

Run Slither on a single file:

$ slither tests/uninitialized.sol 
[..]
INFO:Detectors:
Uninitialized.destination (tests/uninitialized.sol#5) is never initialized. It is used in:
	- transfer (tests/uninitialized.sol#7-9)
Reference: https://github.com/trailofbits/slither/wiki/Vulnerabilities-Description#uninitialized-state-variables
[..]

Slither can be run on:

  • A .sol file
  • A Truffle directory
  • A directory containing *.sol files (all the *.sol files will be analyzed)
  • A glob (be sure to quote the argument when using a glob)

Configuration

  • --solc SOLC: Path to solc (default 'solc')
  • --solc-args SOLC_ARGS: Add custom solc arguments. SOLC_ARGS can contain multiple arguments
  • --disable-solc-warnings: Do not print solc warnings
  • --solc-ast: Use the solc AST file as input (solc file.sol --ast-json > file.ast.json)
  • --json FILE: Export results as JSON

Detectors

By default, all the detectors are run.

Num Detector What it Detects Impact Confidence
1 suicidal Functions allowing anyone to destruct the contract High High
2 uninitialized-state Uninitialized state variables High High
3 uninitialized-storage Uninitialized storage variables High High
4 arbitrary-send Functions that send ether to arbitrary destinations High Medium
5 controlled-delegatecall Controlled delegatecall destination High Medium
6 reentrancy Reentrancy vulnerabilities High Medium
7 locked-ether Contracts that lock ether Medium High
8 constant-function Constant functions changing the state Medium Medium
9 tx-origin Dangerous usage of tx.origin Medium Medium
10 uninitialized-local Uninitialized local variables Medium Medium
11 unused-return Unused return values Medium Medium
12 assembly Assembly usage Informational High
13 constable-states State variables that could be declared constant Informational High
14 external-function Public function that could be declared as external Informational High
15 low-level-calls Low level calls Informational High
16 naming-convention Conformance to Solidity naming conventions Informational High
17 pragma If different pragma directives are used Informational High
18 solc-version Old versions of Solidity (< 0.4.23) Informational High
19 unused-state Unused state variables Informational High

Contact us to get access to additional detectors.

Printers

To run a printer, use --print and a comma-separated list of printers.

Num Printer Description
1 call-graph Export the call-graph of the contracts to a dot file
2 contract-summary Print a summary of the contracts
3 function-summary Print a summary of the functions
4 human-summary Print a human readable summary of the contracts
5 inheritance Print the inheritance relations between contracts
6 inheritance-graph Export the inheritance graph of each contract to a dot file
7 slithir Print the slithIR representation of the functions
8 vars-and-auth Print the state variables written and the authorization of the functions

How to install

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

Using Pip

$ pip install slither-analyzer

Using Git

$ git clone https://github.com/trailofbits/slither.git && cd slither
$ python setup.py install 

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.