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

0.6.6 – 2019-08-16

This release changes internal functions and how modifiers are represented, improves the JSON format, removes detectors’ false positives, and fixes numerous bugs.

Added

• Add exclude-dependencies flag (#269)
• Add Optimization type and --exclude-optimization flag (#265), #269)
• AragonOS detection (#276)
• New printer: constructor calls (#299)

Changed

• [Breaking change] Remove the instance sharing for functions and modifiers. Each function or modifier has now contract and contract_declarer properties, where contract points to the contract’s instance and the contract declarer to the contract where the function was originally declared (#213).
• [Breaking change] Use unique JSON element per detector finding (#263)
• [Breaking change] Add type to JSON result and improve the log in console/file (#266)
• Move third parties tools to slither.tools (#313)
• Remove false positive in external function detector in case of parameter written (#257)
• Remove false positive in naming convention in case of unnamed parameters (#260)
• Remove false positive in naming convention for constructor (aec680c)
• Improve ternary operators support (#301)
• Late conversion of the subdenomination value (#305)
• Refactor reentrancy detector and add support for create-based reentrancy (#311)

Fixed

• Incorrect source mapping for if/while/for condition (#245)
• Incorrect variable order in printer (#254)
• Incorrect source mapping due to text conversion (#252)
• Incorrect type for constant with implicit conversion (#283)
• Incorrect arguments to crytic-compile (4cbe048)

Note: 0.6.5 contained a bug in the reentrancy detector. Please avoid this version since it unnecessarily reported false-positives.

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