Writing Python Plugins¶
Creating the Plugin¶
First, take a look at some of the example plugins, or some of the community plugins to get a feel for different APIs you might be interested in. Of course, the full API docs are online and available offline via the
Open Python API Reference....
To start, we suggest you download the sample plugin as a template since it contains all of the elements you're likely to need.
- Begin by editing the
- Next, update the
- For small scripts, you can include all the code inside of
__init__.py, though we recommend for most larger scripts that init just act as an initializer and call into functions organized appropriately in other files.
- If you have python dependencies, create a requirements.txt listing any python dependencies.
Submitting to the Plugin Manager¶
If your plugin was created as described above, there's only two steps to get it submitted to the plugin manager!
- First, create a release either manually or using our release helper.
- Next, just file an issue letting us know about your plugin.
For future releases all you need to do is increment the version and create a new release.
Using Your Own Plugin Repository¶
The simplest way to run your own plugin repository is to duplicate the structure of https://github.com/vector35/community-plugins. Specifically, the plugins.json, as listing.json is used along with generate_index.py to create that file.
Once you've created your test repository, use the
pluginManager.unofficialUrl settings to add your third-party repository.
add_repository API can also be used to add the repository, though it may require manual creation of the repository folder.
It's useful to be able to reload your plugin during testing. On the Commercial edition of Binary Ninja, this is easily accomplished with a stand-alone headless install using
import binaryninja after installing the API. (install_api.py is included in each platforms respective installation folder)
For other plugins, we recommend the following workflow from the scripting console which enables easy iteration and testing:
import pluginname import importlib importlib.reload(pluginname);pluginname.callbackmethod(bv)
[UP] [ENTER] to trigger the reload when the plugin has changed.
Writing plugins using other IDEs¶
Even though non-commercial licenses don't have headless automation, the install API script (which is included in the installation directory) allows you to add the binaryninja module to your python environment. Once you do that, you should get automatic completion in any editor that supports it even on non-commercial! Of course, on commercial and enterprise installations, the script is even more useful, allowing for headless scripts with your existing python interpreter.
Debugging using other IDEs¶
If you wish to debug your python scripts, there are a few methods specific to different IDEs:
Remote debugging with VSCode:¶
pip install --user debugpyin the Python interpreter you have selected in Binary Ninja Settings.
- In VSCode, open the Run and Debug sidebar.
- Create a
launch.jsonfile if one does not already exist, or open
launch.jsonif one does.
launch.json, select Add Configuration > Python > Remote Attach
- Enter a host of
localhostand any port
- Set the path mapping to be from
- Open Binary Ninja
connect_vscode_debugger(port=12345)in the Python Console, using whichever port you selected in
- In VSCode, start debugging. You should see the bottom toolbar change color, and the debugger should be attached.
Remote debugging with IntelliJ PyCharm¶
WARNING: Does not work on PyCharm Community, requires PyCharm Professional
- In PyCharm, add a Run Configuration for Python Debug Server. Give it a name and choose a port and host.
- Run the
pip installscript displayed in the Run Configuration using whichever python interpreter you have selected for Binary Ninja.
- In PyCharm, start debugging. You should see "Waiting for process connection..." in the Debugger panel.
- Open Binary Ninja
connect_pycharm_debugger(port=12345)in the Python Console, using whichever port you selected in the Run Configuration. You should now see "Connected" in the PyCharm Debugger panel.
Writing Native Plugins¶
Unfortunately, native plugins are not supported in the plugin manager at this time. It's possible to work-around this limitation by pre-building for all three platforms a native plugin and using a python plugin that acts as a loader for the native plugin, but no such examples exist.
Matching API versions¶
One issue with building a native plugin is that you'll want your plugin to be able to match the API of a given dev build. This information is contained in a file named
api_REVISION.txt that exists in the root install folder for Linux, the
Contents/Resources sub-folder on MacOS, and the root installation folder on Windows.
Several native plugin examples exist: