/MUI

A GUI plugin for Binary Ninja to easily interact with and view the progress of Manticore

Primary LanguagePython

MUI

Manticore

With the Manticore User Interface (MUI) project, we provide a graphical user interface plugin for Binary Ninja to allow users to easily interact with and view progress of the Manticore symbolic execution engine for analysis of smart contracts and native binaries.

❗ATTENTION❗ This project is under active development and may be unstable or unusable.

Requirements

Aside from the Python requirements, we require the following:

  • Binary Ninja (latest development version) with GUI
  • git submodule update --init --recursive for Manticore submodule

Installation

MUI requires a copy of Binary Ninja with a GUI. Currently we are testing against the latest dev release(s) (2.4.2898-dev at time of writing).

Manticore only operates on native binaries within a Linux environment. EVM support has only been tested on Mac and Linux.

We attempt to use Poetry for managing dependencies and a development environment. See the Poetry usage guide for more information on how to install dependencies. You can also run make init.

  1. Make the project available to Binary Ninja by creating a symbolic link to the plugins directory. From within the root of this repo, run the following:

    # For Mac
$ ln -s "$(pwd)/mui" "${HOME}/Library/Application Support/Binary Ninja/plugins/mui"

# For Linux
$ ln -s "$(pwd)/mui" "${HOME}/.binaryninja/plugins/mui

  2. Make sure Binary Ninja knows about our Poetry virtual environment.

    1. After setting up the Poetry environment, run poetry env info and note the paths for the "Virtualenv" and "System" -> "Python".
    2. Open Binary Ninja's "Preferences" -> "Settings" -> "Python" and ensure the "Python Interpreter" is correctly set to the Python path associated with the Poetry Python interpreter.
    3. Copy and paste the path from Poetry "Virtualenv" into Binary Ninja's "Python Virtual Environment Site-Packages" and add the required /lib/python3.<minor_version>/site-packages suffix for the site-packages path.
    4. Restart Binary Ninja if necessary.

Development

Installing currently listed dependencies:

$ make init
# For Mac (will be similar for Linux)
$ export PYTHONPATH="/Applications/Binary Ninja.app/Contents/Resources/python:/Applications/Binary Ninja.app/Contents/Resources/python3"

Code style and linting can be followed by running the following:

$ make format
$ make lint

Tests for code without Binary Ninja interaction can be run if you have a headless version of binary ninja available, otherwise only non-Binary Ninja tests will be run:

$ make test

Updating current dependencies:

$ poetry update

Adding a new dependency can either be through manually editing pyproject.toml or the following:

$ poetry add <dependency>