plugin.json

{
   "pluginmetadataversion": 2,
   "name": "Find Code Caves",
   "author": "NicoleFaye",
   "type": [
      "helper"
   ],
   "api": [
      "python3"
   ],
   "description": "Binary Ninja plugin for printing size sorted code cave addresses to console.",
   "longdescription": "# Find Code Caves\n\nA Binary Ninja plugin that scans all executable segments of a loaded binary for \"code caves\" — contiguous runs of filler bytes (`0x90` NOP, `0xCC` INT3, or `0x00` NULL) large enough to be useful for static patching or shellcode injection.\n\n## Features\n\n- Scans every executable segment in the binary\n- Detects runs of NOP, INT3, or NULL bytes\n- Configurable minimum cave size via Binary Ninja Settings (default: 20 bytes)\n- Sorts results by size, largest first\n- Prints a summary table (address, size, byte type, containing segment) to the Binary Ninja log\n- Reports total cave count and total available space\n\n## Usage\n\nRun **Tools > Find Code Caves** (or via the command palette) after loading a binary. Results are printed to the Binary Ninja log window.\n\n## Settings\n\nThis plugin registers a setting under **Edit > Preferences > Settings > Find Code Caves**:\n\n| Setting | Key | Type | Default | Description |\n|---|---|---|---|---|\n| Minimum Cave Size | `findcodecaves.minSize` | number | `20` | Minimum number of contiguous filler bytes required for a run to be reported as a code cave. |\n\nAdjust this value to filter out small, less useful caves, or lower it to surface smaller gaps for tighter patches.\n\n## Notes\n\nThis is a static analysis tool — it only reads segment data as loaded by Binary Ninja's analysis; it does not modify the binary.",
   "license": {
      "name": "MIT",
      "text": "Copyright 2026 NicoleFaye\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
   },
   "platforms": [
      "Darwin",
      "Windows",
      "Linux"
   ],
   "installinstructions": {
      "Darwin": "No special installation steps are required. Install via Binary Ninja's built-in Plugin Manager (Plugins > Manage Plugins), or manually clone this repository into `~/Library/Application Support/Binary Ninja/plugins/`.",
      "Windows": "No special installation steps are required. Install via Binary Ninja's built-in Plugin Manager (Plugins > Manage Plugins), or manually clone this repository into `%APPDATA%\\Binary Ninja\\plugins\\`.",
      "Linux": "No special installation steps are required. Install via Binary Ninja's built-in Plugin Manager (Plugins > Manage Plugins), or manually clone this repository into `~/.binaryninja/plugins/`."
   },
   "version": "1.0.0",
   "minimumbinaryninjaversion": 9757
}