Skip to content

Commit

Permalink
update binassist
Browse files Browse the repository at this point in the history
  • Loading branch information
psifertex committed Sep 12, 2024
1 parent 168abc6 commit 9f0d363
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
|[BD Viewer](https://github.com/PistonMiner/binaryninja-bindiff-viewer)|[Linus S. (aka PistonMiner)](https://github.com/PistonMiner)|View BinDiff results and port symbols|2022-07-26|helper, ui|MIT|
|[Binary Ninja Ollama](https://github.com/ahaggard2013/binaryninja-ollama)|[Austin Haggard](https://github.com/ahaggard2013)|Binary Ninja Ollama integrates with your own locally hosted ollama server to rename functions and variables with AI|2024-07-16|architecture, binaryview, core, helper, ui|MIT|
|[Binary Ninja Type Manager](https://github.com/Ayrx/binja-typemanager)|[Terry Chia](https://github.com/Ayrx)|Manage custom type libraries.|2021-01-30|helper|MIT|
|[BinAssist](https://github.com/jtang613/BinAssist)|[Jason Tang](https://github.com/jtang613)|A plugin that provides LLM helpers to explain code and assist in RE.|2024-09-11|helper, ui|MIT|
|[BinAssist](https://github.com/jtang613/BinAssist)|[Jason Tang](https://github.com/jtang613)|A plugin that provides LLM helpers to explain code and assist in RE.|2024-09-12|helper, ui|MIT|
|[Binja IPython console](https://github.com/skr0x1c0/ipybinja)|[skr0x1c0](https://github.com/skr0x1c0)|IPython console widget for Binary Ninja|2022-12-12|binaryview, core, helper, ui|MIT|
|[binja-doc-lookup](https://github.com/riskydissonance/binja-doc-lookup)|[riskydissonance](https://github.com/riskydissonance)|Lookup documentation for the selected token|2024-06-20|helper, ui|MIT|
|[binja-win-docs](https://github.com/matteyeux/binja-win-docs)|[matteyeux](https://github.com/matteyeux)|Binary Ninja plugin to display the documentation of a Windows function in a sidebar widget.|2024-04-11|helper, ui|Apache-2.0|
Expand Down
64 changes: 32 additions & 32 deletions plugins.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
"python3"
],
"description": "A plugin that provides LLM helpers to explain code and assist in RE.",
"longdescription": "This is a LLM plugin aimed at enabling the use of local LLM's (ollama, text-generation-webui, lm-studio, etc) for assisting with binary exploration and reverse engineering. It supports any OpenAI v1-compatible API. Recommended models are LLaMA-based models such as llama3.1:8b, but others should work as well.\n\nCurrent features include:\n* Explain the current function - Works at all IL levels.\n* Explain the current instruction - Works at all IL levels.\n* General query - Query the LLM directly from the UI.\n* Propose actions - Provide a list of proposed actions to apply.\n* Function calling - Allow agent to call functions to navigate the binary, rename functions and variables.\n* RLHF dataset generation - To enable model fine tuning.\n* RAG augmentation - Supports adding contextual documents to refine query effectiveness.\n* Settings to modify API host, key, model name and max tokens.\n\nFuture Roadmap:\n* Agentic assistant - Use Autogen or similar framework for self-guided binary RE.\n* Model fine tuning - Leverage the RLHF dataset to fine tune the model.\n\n## Screenshot\n![Screenshot](/res/screenshots.gif)\n\n## Homepage\nhttps://github.com/jtang613/BinAssist",
"license": {
"name": "MIT",
"text": "Copyright (c) 2024 Jason Tang\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."
Expand All @@ -26,10 +25,11 @@
"Darwin": "Untested but should work. Submit an Issue or Pull Request for support."
},
"dependencies": "openai\npysqlite3\nmarkdown\nhttpx\nchromadb\nsentence-transformers",
"version": "0.1.0",
"version": "0.1.1",
"author": "Jason Tang",
"minimumbinaryninjaversion": 3164,
"lastUpdated": 1726087901,
"minimumbinaryninjaversion": 4000,
"longdescription": "# BinAssist\nAuthor: **Jason Tang**\n\n_A plugin that provides LLM helpers to explain code and assist in RE._\n\n## Description:\n\nThis is a LLM plugin aimed at enabling the use of local LLM's (ollama, text-generation-webui, lm-studio, etc) for assisting with binary exploration and reverse engineering. It supports any OpenAI v1-compatible API. Recommended models are LLaMA-based models such as llama3.1:8b, but others should work as well.\n\nCurrent features include:\n* Explain the current function - Works at all IL levels.\n* Explain the current instruction - Works at all IL levels.\n* General query - Query the LLM directly from the UI.\n* Propose actions - Provide a list of proposed actions to apply.\n* Function calling - Allow agent to call functions to navigate the binary, rename functions and variables.\n* RLHF dataset generation - To enable model fine tuning.\n* RAG augmentation - Supports adding contextual documents to refine query effectiveness.\n* Settings to modify API host, key, model name and max tokens.\n\nFuture Roadmap:\n* Agentic assistant - Use Autogen or similar framework for self-guided binary RE.\n* Model fine tuning - Leverage the RLHF dataset to fine tune the model.\n\n## Quickstart\n\n* If necessary, `pip install -r requirements.txt` from the plugin directory.\n* Open Settings -> BinAssist.\n* Ensure the RLHF and RAG database paths are appropriate for your environment.\n* Point the API host to your prefered API provider and set the API key. \n* Load a binary.\n* Open BinAssist with the 'BA' sidebar icon and start exploring.\n\n## Screenshot\n![Screenshot](/res/screenshots.gif)\n\n## Homepage\nhttps://github.com/jtang613/BinAssist\n\n\n## Installation Instructions\n\n### Linux\n\nAn OpenAI compatible API is required. For local LLM support, use Ollama, LMStudio, Open-WebUI, Text-Generation-WebUI, etc.\n\n`pip install -r requirements.txt`\n\n### Windows\n\nUntested but should work. Submit an Issue or Pull Request for support.\n\n### Darwin\n\nUntested but should work. Submit an Issue or Pull Request for support.\n\n## Minimum Version\n\nThis plugin requires the following minimum version of Binary Ninja:\n\n* 3164\n\n\n\n## Required Dependencies\n\nThe following dependencies are required for this plugin:\n\n * pip - openai, pysqlite3, markdown, httpx, chromadb, sentence-transformers\n\n\n## License\n\nThis plugin is released under a MIT license.\n## Metadata Version\n\n2\n",
"lastUpdated": 1726171547,
"projectUrl": "https://github.com/jtang613/BinAssist",
"projectData": {
"id": 837757379,
Expand Down Expand Up @@ -98,14 +98,14 @@
"releases_url": "https://api.github.com/repos/jtang613/BinAssist/releases{/id}",
"deployments_url": "https://api.github.com/repos/jtang613/BinAssist/deployments",
"created_at": "2024-08-03T23:56:37Z",
"updated_at": "2024-09-11T20:51:41",
"pushed_at": "2024-09-11T20:50:46Z",
"updated_at": "2024-09-12T20:05:47",
"pushed_at": "2024-09-12T20:33:23Z",
"git_url": "git://github.com/jtang613/BinAssist.git",
"ssh_url": "[email protected]:jtang613/BinAssist.git",
"clone_url": "https://github.com/jtang613/BinAssist.git",
"svn_url": "https://github.com/jtang613/BinAssist",
"homepage": "",
"size": 4576,
"size": 4591,
"stargazers_count": 0,
"watchers_count": 0,
"language": "Python",
Expand Down Expand Up @@ -153,10 +153,10 @@
"subscribers_count": 2
},
"authorUrl": "https://github.com/jtang613",
"packageUrl": "https://api.github.com/repos/jtang613/BinAssist/zipball/refs/tags/0.1.0",
"packageShortUrl": "https://v35.us/uff0jcv",
"packageUrl": "https://api.github.com/repos/jtang613/BinAssist/zipball/refs/tags/0.1.3",
"packageShortUrl": "https://v35.us/ij7uvp2",
"path": "jtang613_BinAssist",
"commit": "68ae4f6870fda9e553b3efd3f4b4d0cdf9e9f0c1",
"commit": "ac10c3e4c98eb8b758d26d7f4818c64bcdec68cb",
"minimumBinaryNinjaVersion": 0
},
{
Expand Down Expand Up @@ -2346,8 +2346,8 @@
"svn_url": "https://github.com/mrphrazer/reverser_ai",
"homepage": "",
"size": 828,
"stargazers_count": 783,
"watchers_count": 783,
"stargazers_count": 784,
"watchers_count": 784,
"language": "Python",
"has_issues": true,
"has_projects": true,
Expand All @@ -2374,7 +2374,7 @@
"visibility": "public",
"forks": 43,
"open_issues": 2,
"watchers": 783,
"watchers": 784,
"default_branch": "main",
"permissions": {
"admin": false,
Expand Down Expand Up @@ -10446,7 +10446,7 @@
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 54,
"open_issues_count": 55,
"license": {
"key": "lgpl-2.1",
"name": "GNU Lesser General Public License v2.1",
Expand All @@ -10468,7 +10468,7 @@
],
"visibility": "public",
"forks": 9,
"open_issues": 54,
"open_issues": 55,
"watchers": 169,
"default_branch": "main",
"permissions": {
Expand Down Expand Up @@ -10927,20 +10927,20 @@
"svn_url": "https://github.com/bootleg/ret-sync",
"homepage": "",
"size": 2792,
"stargazers_count": 1980,
"watchers_count": 1980,
"stargazers_count": 1981,
"watchers_count": 1981,
"language": "C",
"has_issues": true,
"has_projects": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"has_discussions": false,
"forks_count": 255,
"forks_count": 253,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 31,
"open_issues_count": 32,
"license": {
"key": "gpl-3.0",
"name": "GNU General Public License v3.0",
Expand All @@ -10962,9 +10962,9 @@
"software-analysis"
],
"visibility": "public",
"forks": 255,
"open_issues": 31,
"watchers": 1980,
"forks": 253,
"open_issues": 32,
"watchers": 1981,
"default_branch": "master",
"permissions": {
"admin": false,
Expand All @@ -10974,7 +10974,7 @@
"pull": true
},
"temp_clone_token": "",
"network_count": 255,
"network_count": 253,
"subscribers_count": 50
},
"authorUrl": "https://github.com/bootleg",
Expand Down Expand Up @@ -11855,8 +11855,8 @@
"svn_url": "https://github.com/gaasedelen/lighthouse",
"homepage": "",
"size": 11246,
"stargazers_count": 2220,
"watchers_count": 2220,
"stargazers_count": 2222,
"watchers_count": 2222,
"language": "Python",
"has_issues": true,
"has_projects": false,
Expand Down Expand Up @@ -11891,7 +11891,7 @@
"visibility": "public",
"forks": 303,
"open_issues": 19,
"watchers": 2220,
"watchers": 2222,
"default_branch": "master",
"permissions": {
"admin": false,
Expand Down Expand Up @@ -13418,7 +13418,7 @@
"has_wiki": true,
"has_pages": false,
"has_discussions": false,
"forks_count": 60,
"forks_count": 61,
"mirror_url": null,
"archived": false,
"disabled": false,
Expand All @@ -13435,7 +13435,7 @@
"web_commit_signoff_required": false,
"topics": [],
"visibility": "public",
"forks": 60,
"forks": 61,
"open_issues": 0,
"watchers": 553,
"default_branch": "main",
Expand All @@ -13447,7 +13447,7 @@
"pull": true
},
"temp_clone_token": "",
"network_count": 60,
"network_count": 61,
"subscribers_count": 18
},
"authorUrl": "https://github.com/mrphrazer",
Expand Down Expand Up @@ -19806,8 +19806,8 @@
"svn_url": "https://github.com/ForAllSecure/bncov",
"homepage": "",
"size": 6205,
"stargazers_count": 120,
"watchers_count": 120,
"stargazers_count": 121,
"watchers_count": 121,
"language": "Python",
"has_issues": true,
"has_projects": false,
Expand All @@ -19834,7 +19834,7 @@
"visibility": "public",
"forks": 17,
"open_issues": 0,
"watchers": 120,
"watchers": 121,
"default_branch": "master",
"permissions": {
"admin": false,
Expand Down

0 comments on commit 9f0d363

Please sign in to comment.