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.
slither/README.md

114 lines
5.1 KiB

# Slither, the Solidity source analyzer
[![Build Status](https://travis-ci.com/trailofbits/slither.svg?token=JEF97dFy1QsDCfQ2Wusd&branch=master)](https://travis-ci.com/trailofbits/slither)
6 years ago
[![Slack Status](https://empireslacking.herokuapp.com/badge.svg)](https://empireslacking.herokuapp.com)
6 years ago
[![PyPI version](https://badge.fury.io/py/slither-analyzer.svg)](https://badge.fury.io/py/slither-analyzer)
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.
6 years ago
## Features
* Detects vulnerable Solidity code with low false positives
6 years ago
* Identifies where the error condition occurs in the source code
6 years ago
* Easy integration into continuous integration and Truffle builds
6 years ago
* Built-in 'printers' quickly report crucial contract information
* Detector API to write custom analyses in Python
6 years ago
* Ability to analyze contracts written with Solidity >= 0.4
6 years ago
* Intermediate representation ([SlithIR](https://github.com/trailofbits/slither/wiki/SlithIR)) enables simple, high-precision analyses
6 years ago
## Usage
6 years ago
6 years ago
Run Slither on a Truffle application:
```
truffle compile
slither .
```
Run Slither on a single file:
```
$ slither tests/uninitialized.sol # argument can be file, folder or glob, be sure to quote the argument when using a glob
[..]
INFO:Detectors:Uninitialized state variables in tests/uninitialized.sol, Contract: Uninitialized, Vars: destination, Used in ['transfer']
[..]
```
6 years ago
If Slither is run on a directory, it will run on every `.sol` file in the directory.
6 years ago
### Configuration
6 years ago
* `--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
6 years ago
6 years ago
By default, all the detectors are run.
Num | Detector | What it Detects | Impact | Confidence
6 years ago
--- | --- | --- | --- | ---
1 | `suicidal` | Suicidal functions | High | High
2 | `uninitialized-state` | Uninitialized state variables | High | High
3 | `uninitialized-storage` | Uninitialized storage variables | High | High
6 years ago
4 | `arbitrary-send` | Functions that send ether to arbitrary destinations | High | Medium
5 | `reentrancy` | Reentrancy vulnerabilities | High | Medium
6 | `locked-ether` | Contracts that lock ether | Medium | High
7 | `tx-origin` | Dangerous usage of `tx.origin` | Medium | Medium
8 | `assembly` | Assembly usage | Informational | High
9 | `const-candidates-state` | State variables that could be declared constant | Informational | High
10 | `external-function` | Public functions that could be declared as external | Informational | High
11 | `low-level-calls` | Low level calls | Informational | High
12 | `naming-convention` | Conformance to Solidity naming conventions | Informational | High
13 | `pragma` | If different pragma directives are used | Informational | High
14 | `solc-version` | If an old version of Solidity used (<0.4.23) | Informational | High
15 | `unused-state` | Unused state variables | Informational | High
6 years ago
[Contact us](https://www.trailofbits.com/contact/) to get access to additional detectors.
6 years ago
### Printers
6 years ago
To run a printer, use `--printers` and a comma-separated list of printers.
6 years ago
Num | Printer | Description
--- | --- | ---
1 | `call-graph` | the call graph
2 | `contract-summary` | a summary of the contract
3 | `function-summary` | the summary of the functions
4 | `inheritance` | the inheritance relation between contracts
5 | `inheritance-graph` | the inheritance graph
6 | `slithir` | the slithIR
6 years ago
7 | `vars-and-auth` | state variables written and the authorization of the functions
6 years ago
6 years ago
## How to install
Slither requires Python 3.6+ and [solc](https://github.com/ethereum/solidity/), the Solidity compiler.
6 years ago
### Using Pip
6 years ago
```
$ pip install slither-analyzer
```
### Using Git
6 years ago
```bash
$ git clone https://github.com/trailofbits/slither.git && cd slither
6 years ago
$ python setup.py install
```
## Getting Help
6 years ago
Feel free to stop by our [Slack channel](https://empireslacking.herokuapp.com) (#ethereum) for help using or extending Slither.
6 years ago
* The [Printer documentation](https://github.com/trailofbits/slither/wiki/Printer-documentation) describes the information Slither is capable of visualizing for each contract.
6 years ago
6 years ago
* The [Detector documentation](https://github.com/trailofbits/slither/wiki/Adding-a-new-detector) describes how to write a new vulnerability analyses.
6 years ago
6 years ago
* The [API documentation](https://github.com/trailofbits/slither/wiki/API-examples) describes the methods and objects available for custom analyses.
6 years ago
* The [SlithIR documentation](https://github.com/trailofbits/slither/wiki/SlithIR) describes the SlithIR intermediate representation.
6 years ago
## License
Slither is licensed and distributed under the AGPLv3 license. [Contact us](mailto:opensource@trailofbits.com) if you're looking for an exception to the terms.