Slither, the Solidity source 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 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
• 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

Changelog v0.3.1 – 2018-12-03

This release fixes minor bugs and improves the json output.

Changed

• Improve json ouput:
  • Add helpers to abstract_detector
  • Use more detailed output for each detector and more precise source mapping information
  • Document the json: https://github.com/trailofbits/slither/wiki/JSON-output
• Add support for Truffle projects using a truffle-config.js file instead of truffle.js
• Fix incorrect slithIR conversion for mapping of mapping (#83)
• Fix minor bugs (remove duplicate constructors, fix incorrect is_implemented attribute in Modifier)

Install

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

Using Pip

$ pip install slither-analyzer

Using Git

Use

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.

Printers

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

Tutorial

Copyright (C) 2018 trailofbits