PluginName | Author | Description | Last Updated | Type | API | License |
---|---|---|---|---|---|---|
0CD | b0bb | Quality of life utilities for obsessive compulsive CTF enthusiasts. | 2022-02-17 | helper | python3 | MIT |
Add GoReSym Info | Xusheng | Add information recovered by tool GoReSym into the binary view | 2024-07-18 | helper | python3 | MIT |
Add XFG Xref | Xusheng | Add xref from caller to callee based on XFG hashes | 2023-06-11 | helper | python3 | MIT |
AMD-SP/PSP Loader | dayzerosec | Loader for AMD-SP or PSP firmware binaries. | 2023-01-29 | binaryview | python3 | MIT |
Annotate Functions | B.Kerler with code from John Levy and @carstein | A plugin that annotates function arguments. | 2019-07-09 | binaryview | python2 | MIT |
Apple Blocks | Daniel Roethlisberger | Annotation of Apple libclosure blocks. | 2024-12-14 | helper | python3 | MIT |
Ariadne | Mark Griffin (@seeinglogic) | Browser-based interactive graph for viewing callgraph, static analysis, and coverage information | 2023-05-24 | helper, ui | python3 | MIT |
Auto Enum | Lam Jun Rong | Automatically set enums for standard functions | 2024-10-15 | helper | python3 | MIT |
Auto Utils | 404'd | Various auto analysis utilities | 2020-12-12 | helper | python3 | MIT |
Banjo | Austin Ralls | Adds support for Android Dex files | 2024-04-26 | architecture, binaryview | python3 | MIT |
BD Viewer | Linus S. (aka PistonMiner) | View BinDiff results and port symbols | 2022-07-26 | helper, ui | python3 | MIT |
Binary Ninja Ollama | Austin Haggard | Binary Ninja Ollama integrates with your own locally hosted ollama server to rename functions and variables with AI | 2024-10-09 | architecture, binaryview, core, helper, ui | python3 | MIT |
Binary Ninja Type Manager | Terry Chia | Manage custom type libraries. | 2021-01-30 | helper | python3 | MIT |
BinAssist | Jason Tang | A plugin that provides LLM helpers to explain code and assist in RE. | 2024-09-29 | helper, ui | python3 | MIT |
Binja IPython console | skr0x1c0 | IPython console widget for Binary Ninja | 2022-12-12 | binaryview, core, helper, ui | python3 | MIT |
Binja Snapshot Manager | d0minik | Binary Ninja plugin to take and manage database snapshots | 2024-10-30 | helper | python3 | AGPL-3.0 |
binja-doc-lookup | riskydissonance | Lookup documentation for the selected token | 2024-06-20 | helper, ui | python3 | MIT |
binja-ps3 | faith | Playstation 3 ELF loader | 2024-11-28 | binaryview | python3 | MIT |
binja-win-docs | matteyeux | Binary Ninja plugin to display the documentation of a Windows function in a sidebar widget. | 2024-04-11 | helper, ui | python3 | Apache-2.0 |
binja_sigmaker | apekros and Alex3434 | Generate and find signatures. | 2023-01-29 | architecture, binaryview, core, ui | python3 | MIT |
BinjaExportTox64dbg | moval0x1 | Export notations from Binja to x64dbg | 2024-02-20 | binaryview | python3 | MIT |
binjaextras | xorhex | Various features to make windows malware analysis easier. | 2024-12-08 | helper | python3 | MIT |
BinSync | BinSync Team | Adds support for cross-decompiler collab in the BinSync supported decompilers. | 2024-11-05 | sync | python3 | BSD 2-clause |
Blackfin Architecture Plugin | sen | A Binary Ninja architecture plugin for the AD Blackfin architecture | 2022-05-28 | architecture | python3 | GPL-3.0 |
BN KConfig Recover | Brandon Miller | Recover Linux kernel build configurations | 2022-01-14 | helper | python3 | MIT |
bn-riscv | Katharina Utz | RISC-V architecture plugin. | 2021-01-18 | architecture | python2 | Apache-2.0 |
bn-uefi-helper | Brandon Miller (zznop) | Helper plugin for analyzing UEFI firmware | 2023-04-28 | helper | python3 | MIT |
bncov | Mark Griffin | Scriptable code coverage analysis and visualization plugin | 2023-02-15 | helper | python3 | MIT |
BNHook | Grant Orndorff | Insert custom hooks | 2021-03-29 | core, ui | python2 | MIT |
bnida | zznop | Transfer analysis data between Binary Ninja and IDA | 2024-02-15 | sync | python3 | MIT |
BNIL Instruction Graph | Ryan Stortz (@withzombies) | A plugin to graph BNIL instruction trees | 2023-07-19 | ui | python2 | Apache-2.0 |
Call Shellcode | lwerdna | Add "call shellcode" menu option which executes highlighted bytes. | 2021-04-03 | helper | python2 | Unlicense |
Callgraph | Josh Watson / Jordan Wiens | Callgraph generator for called or calling funcs | 2022-04-20 | ui | python3 | MIT |
Calltree | Eric Biazo | Generates calltree. Alternative view for callgraph | 2024-09-04 | binaryview, helper, ui | python3 | MIT |
Char Arrays | elbee | Displays char arrays by analyzing their use in functions | 2023-01-18 | binaryview, helper | python3 | MIT |
ClassyPP | CyShell | Parse and extract class information from MSVC x86 32\64 bit C++ binaries. | 2023-06-06 | binaryview | python3 | MIT |
Clean Tricks | Jan Beck | This plugin removes some simple known obfuscation techniques to cut down on the tedium. | 2020-06-08 | architecture, binaryview, core, helper, ui | python3 | MIT |
Comments Viewer | matteyeux | Binary Ninja comments viewer | 2022-05-27 | ui | python3 | MIT |
CommentsAndSymbols | moval0x1 | Show comments and symbols renamed during the analysis process. | 2024-02-20 | binaryview, ui | python3 | MIT |
CoolSigMaker | unknowntrojan | SigMaker style plugin | 2024-12-17 | helper | rust | AGPLv3 |
cryptoscan | Ben Pottier | A plugin to detect several common crypto constructs and magic vars. | 2023-09-22 | binaryview, ui | python2 | MIT |
ctypes Export | Jordan Whitehead | Export types definitions as ctypes structures | 2024-06-24 | helper | python3 | MIT |
DBG Loader | Gamozo Labs, LLC | Load old COFF .dbg files as well as CAB-ed .db_ files! | 2021-11-15 | helper | python3 | MIT |
decomp2dbg | Zion Basque (@mahaloz) | Adds support for Binary Ninja decompilation in your debugger, curently only supports GDB | 2024-09-08 | core | python3 | BSD 2-clause |
DeGObfuscate | Jamie Hankins | De-obfuscates strings inside of obfuscated Go binaries | 2020-12-02 | helper | python3 | MIT |
Delphi Mapper | Claudio Teixeira | A plugin that renames Delphi functions according to a .map file produced by IDR. | 2024-01-11 | binaryview | python2 | MIT |
Delphi VMT Analyzer | ImNotAVirus | Find Delphi VMTs and generate their structures | 2022-02-21 | helper | python3 | MIT |
Dependency analyzer | Shiz | Analyze dependencies and resolve obfuscated imports | 2020-05-25 | helper | python2 | MIT |
devi | @_murks | devi - DEvirtualize VIrtual calls in C++ binaries | 2020-11-04 | helper, ui | python3 | MIT |
dewolf Decompiler | fkie-cad | Research Decompiler to generate a C-like function representation | 2024-10-01 | helper, ui | python3 | LGPL-2.1 |
Discord Integration | psifertex | Enables Discord Rich Presence Integration for Binary Ninja | 2024-01-09 | helper | python3 | MIT |
Dixie | 3Flatline LLC | Uses Dixie code scanner to find vulnerabilities using the Binary Ninja C representation | 2024-04-02 | ui | python3 | MIT |
droog | amtal | PDF Reference Opcodes Or reGisters. Like IDA's FRIEND/AMIE or Ghidra's "Processor Manual..." right-click menu. | 2024-06-24 | helper | python3 | AGPL-3.0 |
DUMB | toolCHAINZ | DUMB: An Example Architecture for Binary Ninja | 2020-03-01 | architecture, binaryview | python3 | MIT |
Dyld Shared Cache Processor | cynder (kat) | Processing for Apple's dyld_shared_cache format. | 2022-03-01 | architecture, binaryview, core, helper, ui | python3 | MIT |
EFI Inspector | Brandon Miller | Binary Ninja plugin for inspecting UEFI firmware images | 2024-02-28 | helper | python3 | MIT |
Emotet API+string deobfuscator | Francesco Muroni | Deobufscate API calls and strings in unpacked Emotet samples. | 2020-09-21 | helper | python3 | MIT |
ethersplay Ethereum Architecture Plugin | Trail of Bits | A disassembler and lifter for the Ethereum architecture. | 2022-11-03 | architecture | python3 | AGPL-3.0-only |
Explain Instruction | Eric Hennenfent | Displays a window that explains in simple English what an assembly instruction does | 2021-10-10 | helper, ui | python3 | Apache 2 |
Fix stomped imports | LRQA Nettitude | Recover the imports from a stomped PE header by pasting in an IAT dump from dynamic analysis. | 2024-09-19 | architecture, binaryview, core, helper, ui | python3 | MIT |
Format String Analysis | Nick Shipp | Script to automatically annotate variadic printf functions | 2023-03-08 | helper | python3 | MIT |
Format String Finder | jofra | Finds format string vulnerabilities | 2019-07-15 | helper | python3 | MIT |
Frida | Chame1eon | A plugin to integrate the Frida dynamic instrumentation toolkit into Binary Ninja. | 2020-06-01 | helper | python3 | MIT |
Frinja | Dimitris Zervas | Frida plugin for Binary Ninja - continuation of BinRida by @c3r34lk1ll3r | 2024-04-10 | helper | python3 | MIT |
Function ABI | whitequark | A plugin that adds a GUI for changing function ABI. | 2019-11-22 | ui | python2 | BSD-0-clause |
Fuzzable | ex0dus-0x | Framework for Automating Fuzzable Target Discovery with Static Analysis | 2023-11-22 | ui | python3 | MIT |
Game Boy Loader and Architecture Plugin | Hugo Porcher (@icecr4ck) | A loader and diassembler for Game Boy ROMs. | 2020-11-17 | architecture, binaryview | python3 | MIT |
Game ROM Loader | redthing1 | Game ROM Loader for Binary Ninja | 2024-09-04 | architecture, binaryview, core, ui | None | MIT |
GameCube DOL | Linus S. (aka PistonMiner) | GameCube DOL file BinaryView | 2021-07-08 | binaryview | python3 | MIT |
GameCube symbol map loader | Linus S. (aka PistonMiner) | GameCube symbol map loader | 2021-07-08 | helper | python3 | MIT |
GEF-Binja | hugsy | Interface Binary Ninja with GDB-GEF easily. | 2020-05-18 | helper, ui | python3 | MIT |
genesis | zznop | SEGA Megadrive/Genesis ROM Hacking Toolkit | 2024-11-04 | helper, ui | python3 | MIT |
Ghinja | Martin Petran | Plugin to embed Ghidra Decompiler into Binary Ninja | 2022-06-08 | ui | python3 | Apache-2.0 |
Go Calling Convention | Linus S. (aka PistonMiner) | Adds the "gocall" calling convention | 2023-12-14 | helper | python3 | MIT |
GO Loader Assist | Michael Rodler | Short script that parses go symbol table and renames/creates functions. | 2021-02-02 | ui | python2 | MIT |
GoLang binary parser | Jacopo Ferrigno | BinaryNinja plugin to parse GoLang binaries and restore some information, like function names and type information | 2023-01-05 | ui | python3 | MIT |
Golang Symbol Restore | Daniel Weber | Binary Ninja plugin for restoring function names from stripped Golang binaries | 2020-10-19 | helper | python3 | MIT |
Golang Symbol Restore 1.18+ | Spencer Merrill | Binary Ninja plugin for restoring function names from stripped Golang binaries | 2022-09-08 | helper | python3 | MIT |
GTIRB | Adrian Herrera | Support the GrammaTech Intermediate Representation for Binaries (GTIRB) in Binary Ninja | 2024-10-07 | helper | python3 | MIT |
HashDB | Cindy Xiao | Plugin for interacting with the OALabs HashDB service. | 2024-10-02 | helper, ui | python3 | 3-Clause BSD |
Hex Integers in Python Console | Glenn Smith | Makes your integers print as hex in the python console. | 2023-11-01 | helper | python3 | MIT |
hexfiles | toolCHAINZ | A simple loader for Motorola SREC, Intel HEX, and TI-TXT files. | 2024-04-09 | binaryview | python3 | MIT |
HLIL Dump | atxsinn3r | Dumps HLIL code to a directory | 2020-06-07 | helper | python2 | BSD-3-Clause |
Hyara | Hyun Yi | YARA rule making tool for Binary Ninja, Cutter, and IDA | 2023-11-13 | ui | python2 | MIT |
iBoot64 Loader | Blackwing Intelligence | Binary View for loading iBoot, SecureROM, etc. firmware | 2020-10-01 | binaryview | python3 | MIT |
iBootLoader | EliseZeroTwo | iBoot/SecureROM Loader | 2023-02-24 | binaryview, helper | python3 | ISC |
IDC Importer | SpecterDev | Allows users to import idc database dumps from IDA into Binary Ninja. | 2022-10-13 | helper | python3 | MIT |
IFL | Leandro Froes | A small plugin that provides an user-friendly way to navigate between functions and their references. | 2024-07-09 | helper, ui | python3 | CC BY 3.0 |
ilhierarchy | Fabian Freyer | Show current IL instruction hierarchy in sidebar | 2022-02-06 | core, ui | python3 | MIT |
Improved Gameboy Architecture | Sam Russell (@samrussell) | A loader and diassembler for Game Boy ROMs. | 2024-03-28 | architecture, binaryview | python3 | MIT |
Instruction Slicer | Andrea Ferraris | Forward and backward instruction slicer | 2020-11-25 | helper | python2 | MIT |
Intel 8086 Architecture | whitequark | A plugin providing the 16-bit Intel architecture. | 2019-09-04 | arch | python2 | BSD-0-clause |
Itanium C++ ABI | whitequark | A plugin providing an analysis for Itanium C++ ABI. | 2023-03-01 | analysis | python2 | BSD-0-clause |
JMPscare | Lukas Seidel | Fuzzing Introspection for use with the JMPscare Toolkit. | 2022-12-07 | binaryview, core, helper, ui | python3 | MIT |
JNIAnalyzer | Terry Chia (Ayrx) | Analysis scripts for Binary Ninja to work with Android NDK libraries. | 2022-03-27 | helper | python3 | MIT |
Jump table branch editor | jofra | A plugin that eases fixing jump table branches | 2019-07-06 | core, ui | python2 | MIT |
kallsyms | Brandon Miller | Parses output from /proc/kallsyms and applies symbols to the corresponding kernel BN database | 2022-01-30 | helper | python3 | MIT |
keypatch | lwerdna | Remake of keypatch plugin for Binary Ninja | 2024-01-25 | helper, ui | python3 | Unlicense |
Lighthouse | Markus Gaasedelen | A Coverage Explorer for Reverse Engineers | 2024-02-05 | helper | python3 | MIT |
logrn | catnip | binary ninja plugin for abusing logging functions | 2021-03-09 | helper | python3 | MIT |
MobiCore Loader Format | vrzh | Loader for MobiCore trustlets and secure drivers. | 2024-07-19 | binaryview, helper | python3 | MIT |
Motorola 68k Architecture Plugin | Galen Williamson | A disassembler and lifter for the Motorola 68k architecture. | 2022-06-10 | architecture | python3 | MIT |
msp430 Architecture | Josh Watson | MSP430 Architecture Plugin for Binary Ninja | 2022-02-02 | architecture | python3 | MIT |
MSVC | Brick | Parses MSVC structures to improve analysis | 2019-07-12 | helper | python2 | MIT |
Nampa | Paolo Montesel (https://github.com/thebabush) | FLIRT for (binary) ninjas | 2020-05-27 | binaryview, core | python3 | LGPL v3 |
Native SigScan | rikodot | Find and create signatures | 2024-08-13 | helper | python2 | MIT |
NEC850 Architecture | Accenture (Martin Petran) | Architecture plugin for Renesas RH850/V850 family of processors. | 2024-10-11 | architecture | C++ | Apache-2.0 |
Notepad | Jon Palmisciano | A notepad for taking notes inside Binary Ninja. | 2021-04-19 | None | python3 | MIT |
Obfuscation Detection | Tim Blazytko | Automatically detect obfuscated code and other interesting code constructs | 2024-04-29 | helper | python3 | GPL-2.0 |
Opaque Predicates Detective | Yu-Jye Tung | detect opaque predicates | 2021-04-10 | helper | python2 | MIT |
OpenAI GPT3 | Sean Deaton (@WhatTheFuzz) | Queries OpenAI's GPT3 to determine what a given function does. | 2024-04-17 | helper | python3 | MIT |
Original Xbox Executable Loader | xclusivor | Loader for Original Xbox Executables | 2023-11-13 | binaryview | python3 | MIT |
pd-ninja | lockbox | Playdate Console RE utilities | 2023-03-01 | helper | python3 | MIT |
permap | Red Balloon Security | Supports loading .per files into Binary Ninja. | 2024-12-18 | helper | python3 | Apache-2.0 |
peutils | 404'd | Binary Ninja plugin providing various niche utilities for working with PE binaries | 2020-12-12 | helper | python3 | MIT |
PowerPC VLE Extension | Martin Petran | PowerPC VLE support via architecture extension. | 2024-10-02 | architecture | cpp | Apache-2.0 |
Pseudo C Dump | Asher Davila L. | Binary Ninja plugin to dump the Pseudo C generated by Binja into a folder. | 2023-01-28 | helper | python3 | Apache-2.0 |
PSVitaLoader | computerman00 | PS Vita ELF/PRX2 loader plugin | 2024-09-19 | helper | python3 | MIT |
Python bytecode | Njörd | Python bytecode (.pyc) support for Binary Ninja | 2024-03-03 | architecture, binaryview | python3 | MIT |
QSettings Viewer | Jordan Wiens | QSettings Viewer | 2024-10-22 | helper, ui | python3 | MIT |
recursion | zznop | Locate and annotate direct and indirect recursion | 2020-07-22 | helper | python3 | MIT |
Renesas M16C Architecture | whitequark | A plugin providing the Renesas M16C architecture. | 2020-01-19 | architecture | python3 | BSD-0-clause |
Renesas V850 architecture plugin | Tomonori Izumida [email protected] | An architecture plugin for Renesas V850 series | 2022-11-07 | architecture | python3 | MIT |
ret-sync | Alexandre Gazet | Helper plugin to synchronize Binary Ninja with a debugging session | 2022-01-21 | helper | python3 | MIT |
ReverserAI | Tim Blazytko | Provides automated reverse engineering assistance through the use of local large language models (LLMs) on consumer hardware. | 2024-06-21 | helper | python3 | GPL-2.0 |
revsync | lunixbochs | Realtime IDA Pro and Binary Ninja sync plugin | 2020-05-14 | ui | python2 | MIT |
ripr | Patrick Biernat | Package binary code as a Python class backed by Unicorn-Engine | 2022-07-08 | helper | python3 | MIT |
RopView | elbee | RopView is a gadget analysis framework for BinaryNinja capable of granular per-instruction based analysis and complex logical queries. | 2024-06-02 | binaryview, helper, ui | python3 | MIT |
Rust Demangle | inspier | Demangles Rust symbols. | 2023-07-09 | helper | python3 | MIT |
Rust String Slicer | Cindy Xiao | Rust binary string recovery plugin | 2023-12-25 | helper | python3 | MIT |
Rust Type Layout Helper | Cindy Xiao | An extremely experimental Binary Ninja importer for the type layout information emitted by the -Zprint-type-sizes flag of the Rust compiler. | 2023-04-27 | helper | python3 | MIT |
Screenshot Ninja | jonpalmisc | Easily capture Binary Ninja screenshots in ultra-high resolution | 2024-02-26 | helper | python3 | MIT |
SEH Helper | EliseZeroTwo | Helper for exploring structured exception handlers in PEs | 2022-02-19 | helper, ui | python3 | MIT |
semgrep-bn | Samman Palihapitiya | Search code with Semgrep | 2024-04-10 | helper | python3 | MIT |
SENinja | Luca Borzacchiello | Symbolic execution plugin for BinaryNinja | 2024-02-24 | helper | python3 | 2-Clause BSD |
SEPROM Loader | matteyeux | Binary View for loading 32 bits and 64 bits Apple SEPROM | 2023-07-17 | binaryview | python3 | MIT |
Shellcoder | 434b | Interactive shellcode disassembler/assembler | 2024-11-28 | helper | python3 | Apache 2.0 |
Sourcery Pane | mechanicalnull | Synchronized source code pane for debug binaries | 2019-07-15 | helper, ui | python2 | MIT |
Swift Demangler | Saagar Jha | Demangles Swift functions. | 2023-09-15 | architecture, binaryview, core, helper, ui | python3 | MIT |
Switch Loader | EliseZeroTwo | Loader for common Nintendo Switch binaries | 2020-07-22 | binaryview, helper | python3 | ISC |
Symgrate2 Plugin | Travis Goodspeed | This is a client plugin for recovering symbols using the Symgrate2 server. | 2021-09-11 | helper | python3 | MIT |
Syscaller | Michal Melewski | Decorate encountered syscalls with details like name and arguments | 2019-07-15 | helper | python3 | MIT |
Tag Team | psifertex | Tags functions using emoji for a number of interesting characteristics | 2021-03-12 | helper | python3 | Apache-2.0 |
TE Loader | Brandon Miller | Binary Ninja plugin for loading EFI Terse Executable files | 2024-02-28 | architecture | python3 | MIT |
themida-unmutate-bn | Erwan Grelet | Static deobfuscator for Themida, WinLicense and Code Virtualizer 3.x's mutation-based obfuscation. | 2024-07-28 | helper | python3 | GPL-3.0-or-later |
TypeLib Exporter | SmoothHacker | This plugin compiles exported functions and its corresponding types into a type library. Type libraries can also be applied to existing bndbs through this plugin. | 2022-10-15 | binaryview, helper, ui | python3 | MIT |
UniSymbol | redthing1 | Import/Export symbols from/to IDA, Ghidra, and Binary Ninja | 2024-09-07 | binaryview, ui | None | MIT |
VMNDH-2k12 Architecture Plugin | verylazyguy | A disassembler and lifter for the VMNDH-2k12 architecture. | 2019-07-10 | architecture | python2 | MIT |
VTIL Plugin | Layle | Integrates the VTIL (Virtual-machine Translation Intermediate Language) Project with Binary Ninja | 2020-07-05 | architecture, binaryview | python2 | BSD-3-Clause |
VulnFanatic | Martin Petran | Assistant plugin for vulnerability research. | 2024-09-07 | helper | python3 | Apache-2.0 |
WASM Plugin | Meador Inge | This is a plugin for disassembling and lifting WASM images.. | 2020-06-30 | architecture, binaryview | python3 | MIT |
Windows Driver Analyzer | shareef12 | Find IRP dispatch routines and valid IOCTLs in a Windows kernel driver | 2019-08-08 | helper | python2 | MIT |
x64dbgbinja | x64dbg | Official x64dbg plugin for Binary Ninja. | 2024-10-23 | sync | python3 | MIT |
XNU Sysctl Hunter | actae0n | XNU Sysctl Hunter is a tool for analyzing Kexts that will automatically identify, type, and tag sysctl OIDs, as well as correct the prototypes of their OID handler functions. It contains a Binary Ninja plugin action, as well as a headless script for cli use. | 2021-07-22 | helper | python3 | MIT |
Xtensa Architecture and ESP8266 Loader | Zack Orndorff | Xtensa Architecture and ESP8266 Image Loader | 2021-08-17 | architecture, binaryview | python3 | MIT |
YARA Scan | trib0r3 | YARA signatures | 2020-05-26 | binaryview, core | python3 | MIT |
μBlaze Architecture Plugin | amtal | Configurable soft core for Xilinx FPGAs. | 2022-05-29 | architecture | python3 | MIT |
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 -p
to interactively walk you through setting the required fields. Theplugin.json
must pass all the checks when run throughgenerate_plugininfo.py -v plugin.json
.generate_plugininfo.py
can also generate yourREADME.md
and yourLICENSE
file 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 integer2
name
- 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 onlypython3
is supported.license
- A json object withname
andtext
keys.description
- This is a short (<50 character) description of the plugin.version
- Version stringminimumBinaryNinjaVersion
- An integer build number so instead of1.1.555
use555
.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.sync
- A plugin that synchronizes data with an external tool.
installinstructions
- A json object with keys for each supported platform listed inplatforms
and text Markdown formatted.
Note that content contained in the root of this repository itself is Copyright 2016-2024, Vector 35, Inc. and available under an MIT license, but each individual plugin may be released under a different license.