mirror of https://github.com/ConsenSys/mythril
blockchainethereumsmart-contractssoliditysecurityprogram-analysissecurity-analysissymbolic-execution
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.
103 lines
4.5 KiB
103 lines
4.5 KiB
# Mythril
|
|
|
|
<p align="center">
|
|
<img src="/static/mythril_new.png" height="320px"/>
|
|
</p>
|
|
|
|
[](https://discord.gg/E3YrVtG)
|
|
[](https://pypi.python.org/pypi/mythril)
|
|
[](https://mythril-classic.readthedocs.io/en/master/)
|
|
|
|
[](https://sonarcloud.io/dashboard?id=mythril)
|
|
[](https://pepy.tech/project/mythril)
|
|
[](https://cloud.docker.com/u/mythril/repository/docker/mythril/myth)
|
|
|
|
Mythril is a security analysis tool for EVM bytecode. It detects security vulnerabilities in smart contracts built for Ethereum, Hedera, Quorum, Vechain, Roostock, Tron and other EVM-compatible blockchains. It uses symbolic execution, SMT solving and taint analysis to detect a variety of security vulnerabilities. It's also used (in combination with other tools and techniques) in the [MythX](https://mythx.io) security analysis platform.
|
|
|
|
If you are a smart contract developer, we recommend using [MythX tools](https://github.com/b-mueller/awesome-mythx-smart-contract-security-tools) which are optimized for usability and cover a wider range of security issues.
|
|
|
|
Whether you want to contribute, need support, or want to learn what we have cooking for the future, our [Discord server](https://discord.gg/E3YrVtG) will serve your needs.
|
|
|
|
## Installation and setup
|
|
|
|
Get it with [Docker](https://www.docker.com):
|
|
|
|
```bash
|
|
$ docker pull mythril/myth
|
|
```
|
|
|
|
Install from Pypi (Python 3.6-3.9):
|
|
|
|
```bash
|
|
$ pip3 install mythril
|
|
```
|
|
|
|
See the [docs](https://mythril-classic.readthedocs.io/en/master/installation.html) for more detailed instructions.
|
|
|
|
## Usage
|
|
|
|
Run:
|
|
|
|
```
|
|
$ myth analyze <solidity-file>
|
|
```
|
|
|
|
Or:
|
|
|
|
```
|
|
$ myth analyze -a <contract-address>
|
|
```
|
|
|
|
Specify the maximum number of transaction to explore with `-t <number>`. You can also set a timeout with `--execution-timeout <seconds>`.
|
|
|
|
Here is an example of running Mythril on the file `killbilly.sol` which is in the `solidity_examples` directory for `3` transactions:
|
|
|
|
```
|
|
> myth a killbilly.sol -t 3
|
|
==== Unprotected Selfdestruct ====
|
|
SWC ID: 106
|
|
Severity: High
|
|
Contract: KillBilly
|
|
Function name: commencekilling()
|
|
PC address: 354
|
|
Estimated Gas Usage: 974 - 1399
|
|
Any sender can cause the contract to self-destruct.
|
|
Any sender can trigger execution of the SELFDESTRUCT instruction to destroy this contract account and withdraw its balance to an arbitrary address. Review the transaction trace generated for this issue and make sure that appropriate security controls are in place to prevent unrestricted access.
|
|
--------------------
|
|
In file: killbilly.sol:22
|
|
|
|
selfdestruct(msg.sender)
|
|
|
|
--------------------
|
|
Initial State:
|
|
|
|
Account: [CREATOR], balance: 0x2, nonce:0, storage:{}
|
|
Account: [ATTACKER], balance: 0x1001, nonce:0, storage:{}
|
|
|
|
Transaction Sequence:
|
|
|
|
Caller: [CREATOR], calldata: , decoded_data: , value: 0x0
|
|
Caller: [ATTACKER], function: killerize(address), txdata: 0x9fa299cc000000000000000000000000deadbeefdeadbeefdeadbeefdeadbeefdeadbeef, decoded_data: ('0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',), value: 0x0
|
|
Caller: [ATTACKER], function: activatekillability(), txdata: 0x84057065, value: 0x0
|
|
Caller: [ATTACKER], function: commencekilling(), txdata: 0x7c11da20, value: 0x0
|
|
|
|
```
|
|
|
|
|
|
Instructions for using Mythril are found on the [docs](https://mythril-classic.readthedocs.io/en/master/).
|
|
|
|
For support or general discussions please join the Mythril community on [Discord](https://discord.gg/E3YrVtG).
|
|
|
|
## Building the Documentation
|
|
Mythril's documentation is contained in the `docs` folder and is published to [Read the Docs](https://mythril-classic.readthedocs.io/en/develop/). It is based on Sphinx and can be built using the Makefile contained in the subdirectory:
|
|
|
|
```
|
|
cd docs
|
|
make html
|
|
```
|
|
|
|
This will create a `build` output directory containing the HTML output. Alternatively, PDF documentation can be built with `make latexpdf`. The available output format options can be seen with `make help`.
|
|
|
|
## Vulnerability Remediation
|
|
|
|
Visit the [Smart Contract Vulnerability Classification Registry](https://swcregistry.io/) to find detailed information and remediation guidance for the vulnerabilities reported.
|
|
|