Damian Pfammatter
568b1d8043
* Added support for functions * Added unit-test for propagators * Updated documentation * Updated documentation and increase of patch version * Prevent newlines in YML files * First draft of new function-centric configuration * Fixed unit-tests * Distinguish src_par_slice and snk_par_slice * Cleanup * Updated popup dialogs * Remove empty aliases * Fix adding functions to new categories * Add tree items without tab refresh * Added context menu and remove functionality * Always fix functions * Updated documentation * Rename propagator to fixer * Updated documentation * Quotes in log messages * Try to restore path instruction using instruction address * Changing log outputs * Improved upwards propagation of checkbox states * Update analysis without waiting * Run re-analysis after function type signature fixes in non-UI thread * Include Path for type checking only * Support for installation with uv * Minor change in the installation instructions * Fix functions outside UI thread * Use proper session ID in logger
2.6 KiB
Installation
Plugin Manager
Mole is available through the Binary Ninja Plugin Manager:
- Open Binary Ninja
- Navigate to
Plugins/Manage Plugins - Search for
Mole - Click
Install
This is the simplest available installation method. However, if you also want to use Mole in headless mode or contribute to development, follow the manual installation instructions below.
Manual Installation
In the following, we assume that the variables $BINJA_BIN and $BINJA_USR point to your Binary Ninja's binary path and user folder, respectively.
Use the following steps to install Mole manually:
-
Clone the repository into the Binary Ninja user plugins directory:
cd $BINJA_USR/plugins/ git clone https://github.com/cyber-defence-campus/mole.git mole-dev && cd mole-dev/Warning: Avoid naming the target directory
mole. Usingmolemay conflict with installations managed by the Plugin Manager. -
Install Mole using one of the following options:
Option 1: Using
uv:# Option 1.A: Standard installation uv run python $BINJA_BIN/scripts/install_api.py # Option 1.B: Development installation uv run --extra dev python $BINJA_BIN/scripts/install_api.py uv run pre-commit install # Run Mole headless uv run mole -hOption 2: Using
python-pip:# Create and activate a Python virtual environment (optional, but recommended) python3 -m venv .venv source .venv/bin/activate # Install the Binary Ninja Python API python $BINJA_BIN/scripts/install_api.py # Option 2.A: Standard installation pip install . # Option 2.B: Development installation pip install -e .[dev] pre-commit install # Run Mole headless mole -h -
Depending on your setup, you may need to configure Binary Ninja to use the same Python interpreter and virtual environment as Mole.
Relevant settings:
python.interpreterpython.virtualenv
Example values:
python.interpreter(or):~/.local/share/uv/python/cpython-3.11-linux-x86_64-gnu/lib/libpython3.11.so/usr/lib/x86_64-linux-gnu/libpython3.11.so.1.0
python.virtualenv:$BINJA_USR/plugins/mole-dev/.venv/lib/python3.11/site-packages