Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

A Python library for the MythX platform

Project description

PythX

https://img.shields.io/pypi/v/pythx.svg https://img.shields.io/travis/dmuhs/pythx.svg Documentation Status Updates https://coveralls.io/repos/github/dmuhs/pythx/badge.svg?branch=master

PythX is a library for the MythX smart contract security analysis platform.

What is MythX?

MythX is a security analysis API that allows anyone to create purpose-built security tools for smart contract developers. Tools built on MythX integrate seamlessly into the development environments and continuous integration pipelines used throughout the Ethereum ecosystem.

Installation

PythX runs on Python 3.5+.

To get started, simply run

$ pip3 install pythx

Alternatively, clone the repository and run

$ pip3 install .

Or directly through Python’s setuptools:

$ python3 setup.py install

Example

PythX aims to provide an easy-to-use interface to the official MythX API. Its goal is to turbocharge tool development and make it easy to deal with even complex use cases.

from pythx import Client


# login as free trial user
c = Client(eth_address="0x0000000000000000000000000000000000000000", password="trial")

# submit bytecode, source files, their AST and more!
resp = c.analyze(bytecode="0xfe")

# wait for the analysis to finish
while not c.analysis_ready(resp.uuid):
    time.sleep(1)

# have all your security report data at your fingertips
for issue in c.report(resp.uuid):
    print(issue.swc_title or "Undefined", "-", issue.description_short)

# Output:
# Assert Violation - A reachable exception has been detected.
# Undefined - MythX API trial mode.

The PythX CLI

The PythX CLI aims to be a simple example implementation to show developers on a practical example how PythX can be used in action. It provides a simple (and pretty!) interface to list analyses, submit new ones, check the status of a job, and get report data on the found issues.

$ pythx
Usage: pythx [OPTIONS] COMMAND [ARGS]...

    The basic click CLI command group to register our subcommands under.

Options:
    --help  Show this message and exit.

Commands:
    check    Submit a new analysis job based on source code, byte code, or...
    login    Login to your MythX account
    logout   Log out of your MythX account
    openapi  Get the OpenAPI spec in HTML or YAML format
    ps       Get a greppable overview of submitted analyses
    refresh  Refresh your MythX API token
    report   Check the detected issues of a finished analysis job
    status   Get the status of an analysis by its UUID
    top      Display the most recent analysis jobs and their status
    truffle  Submit a Truffle project to MythX
    version  Print version information of PythX and the API

By default, PythX comes with a pre-enabled trial user. To get started right away, simply login with the default values:

$ pythx login
Please enter your Ethereum address [0x0000000000000000000000000000000000000000]:
Please enter your MythX password [trial]:
Successfully logged in as 0x0000000000000000000000000000000000000000

If you already have an account on MythX, simply login with your Ethereum address and the API password you have set on the website.

Submit an Solidity source file for analysis:

$ pythx check -sf test.sol
Analysis submitted as job df137587-7fc1-466a-a4b2-d63392099682

Check the status of your analysis job:

$ pythx status df137587-7fc1-466a-a4b2-d63392099682
╒════════════════╤══════════════════════════════════════╕
│ uuid           │ df137587-7fc1-466a-a4b2-d63392099682 │
├────────────────┼──────────────────────────────────────┤
│ apiVersion     │ v1.4.3                               │
├────────────────┼──────────────────────────────────────┤
│ mythrilVersion │ 0.20.0                               │
├────────────────┼──────────────────────────────────────┤
│ maestroVersion │ 1.2.3                                │
├────────────────┼──────────────────────────────────────┤
│ harveyVersion  │ 0.0.13                               │
├────────────────┼──────────────────────────────────────┤
│ maruVersion    │ 0.3.4                                │
├────────────────┼──────────────────────────────────────┤
│ queueTime      │ 0                                    │
├────────────────┼──────────────────────────────────────┤
│ runTime        │ 0                                    │
├────────────────┼──────────────────────────────────────┤
│ status         │ Finished                             │
├────────────────┼──────────────────────────────────────┤
│ submittedAt    │ 2019-03-05T10:24:05.071Z             │
├────────────────┼──────────────────────────────────────┤
│ submittedBy    │ 123456789012345678901234             │
╘════════════════╧══════════════════════════════════════╛

Get the analysis report. Pinpointing the line and column locations is still a bit buggy, sorry. :)

$ pythx report df137587-7fc1-466a-a4b2-d63392099682
Report for Unknown
╒════════╤══════════════════╤════════════╤═══════════════════════════════════╕
│   Line │ SWC Title        │ Severity   │ Short Description                 │
╞════════╪══════════════════╪════════════╪═══════════════════════════════════╡
│      0 │ Reentrancy       │ High       │ persistent state read after call  │
├────────┼──────────────────┼────────────┼───────────────────────────────────┤
│      0 │ Reentrancy       │ High       │ persistent state write after call │
├────────┼──────────────────┼────────────┼───────────────────────────────────┤
│      0 │ Assert Violation │ Medium     │ assertion violation               │
╘════════╧══════════════════╧════════════╧═══════════════════════════════════╛

History

1.1.7 [2019-04-20]

  • Add main docstring description

1.1.6 [2019-04-19]

  • Add mainSource support to CLI
  • Fix bug where submission object was malformed (“AST” -> “ast”)
  • Upgrade pytest dependency

1.1.5 [2019-04-16]

  • Add middleware to disable analysis cache
  • Add CLI support to analyze compiled Truffle projects
  • Fix bug where reports were not completely shown
  • Update the authentication data format
  • Add support for the mainSource field
  • Add shortcut to inject middlewares in Client

1.1.4 [2019-03-28]

  • Fix issue in schema detection
  • Upgrade Sphinx dependency

1.1.3 [2019-03-25]

  • Initial release!
  • 100% branch coverage achieved
  • 100% doc coverage achieved
  • Examples provided in repo readme
  • Automatic PyPI deployment on version tag change

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pythx-1.1.7-py2.py3-none-any.whl (78.8 kB) Copy SHA256 hash SHA256 Wheel py2.py3
pythx-1.1.7.tar.gz (200.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page