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.
58 lines
2.9 KiB
58 lines
2.9 KiB
# Mythril Classic
|
|
|
|
<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://waffle.io/ConsenSys/mythril-classic/)
|
|
[](https://sonarcloud.io/dashboard?id=mythril)
|
|
[](https://pepy.tech/project/mythril)
|
|
|
|
Mythril Classic is an open-source security analysis tool for Ethereum smart contracts. It uses symbolic analysis, taint analysis and control flow checking to detect a variety of security vulnerabilities.
|
|
|
|
Note that Mythril Classic is designed for security auditors. If you are a smart contract developer, we recommend using [MythX tools](https://github.com/b-mueller/awesome-mythx-smart-contract-security) which are optimized for usability and cover a wider range of security issues:
|
|
|
|
- [Sabre](https://github.com/b-mueller/sabre)
|
|
- [MythX Plugin for Truffle](https://github.com/ConsenSys/truffle-security)
|
|
|
|
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:
|
|
|
|
```bash
|
|
$ pip3 install mythril
|
|
```
|
|
|
|
See the [Wiki](https://github.com/ConsenSys/mythril/wiki/Installation-and-Setup) for more detailed instructions.
|
|
|
|
## Usage
|
|
|
|
Instructions for using Mythril Classic are found on the [Wiki](https://github.com/ConsenSys/mythril-classic/wiki).
|
|
|
|
For support or general discussions please join the Mythril community on [Discord](https://discord.gg/E3YrVtG).
|
|
|
|
## Bulding the Documentation
|
|
Mythril Classic's documentation is contained in the `docs` folder and is published to [Read the Docs](https://mythril-classic.readthedocs.io/en/master/). 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://smartcontractsecurity.github.io/SWC-registry/) to find detailed information and remediation guidance for the vulnerabilities reported.
|
|
|