| PluginName | Author | Last Updated | License | Type | Description |
|---|---|---|---|---|---|
| ManticoreUI | Trail of Bits | 2022-07-26 | AGPL-3.0 | helper, ui | Graphical user interface to interact with Manticore symbolic execution engine |
Plugins in this repository are provided by the community. Vector 35, Inc. makes no guarantees to the quality, safety or efficacy of the plugins herein.
This repository tracks third-party plugins, but many official plugins are provided by Vector 35 that offer additional functionality:
- Example Plugins are included with all installs of Binary Ninja and can be installed from there
- Official Samples a fully formed repository of official plugins
- Sample Plugin if you're looking for a template to build a new plugin from
To install plugins, you can either use the Plugin Manager in the UI or clone the repositories linked here in into your plugin folder.
- Create a new repository (Optionally, just copy it from the sample plugin)
- Fill out a
plugin.json. Optionally you can use thegenerate_plugininfo.py -pto interactively walk you through setting the required fields. Theplugin.jsonmust pass all the checks when run throughgenerate_plugininfo.py -v plugin.json.generate_plugininfo.pycan also generate yourREADME.mdand yourLICENSEfile with the-r,-l, or-a(all) options. Below is a list of the required and recommended fields. - Create and push a git tag with the version of your plugin (e.g.
v1.1). Create a release, optionally attaching build artifacts as required. We recommend using our release helper which simplifies this process. - File an issue with a link to your repo.
- To update your plugin, simply do a new release! For future updates we'll automatically detect and add the new release to the plugin manager for you! (This previously was a manual step that has been since automated)
To be displayed in the plugin loader, your plugin.json MUST have the following fields:
pluginmetadataversion- The current version is the integer2name- Good names do not use "Binary Ninja" or "Binja" neither do they use the words "plugin" or "extension". So instead of "Binja 6502 Architecture Plugin" simply use "6502 Architecture"author- Your name, handle, or company name.api- A list of supported architectures. Currently onlypython3is supported.license- A json object withnameandtextkeys.description- This is a short (<50 character) description of the plugin.version- Version stringminimumBinaryNinjaVersion- An integer build number so instead of1.1.555use555.platforms- A list of strings one for each supported platform. Valid platforms areDarwin,Linux, andWindows
longdescription- A longer Markdown formatted description of the plugin including hyperlinks and images as needed. This will be shown in the plugin preview in the plugin manager and images are highly recommended. If not specified or if empty, the README file from your repository will be automatically used instead.type- A list of strings of the following types:core,ui,architecture,binaryview, andhelper.helper- Plugin that adds some base functionality to Binary Ninja. Most plugins will be of this type.ui- The plugin extends the UI is some way.architecture- The plugin adds an architecture (e.g.x86,ARM,MIPS).binaryview- The plugin adds a new BinaryView (e.g.PE,MachO,ELF).core- Plugin that extends the core's analysis. Your plugin probably isn't one of these.
installinstructions- A json object with keys for each supported platform listed inplatformsand text Markdown formatted.
Note that content contained in the root of this repository itself is Copyright 2016, Vector 35, Inc. and available under an MIT license, but each individual plugin may be released under a different license.