Merge pull request #10 from WhatTheFuzz/fix/plugin

Validate plugin with Binary Ninja's validation tool.

Author: WhatTheFuzz

README.md

@@ -2,14 +2,24 @@
 
 # BinaryNinja-OpenAI
 
-Integrates OpenAI with BinaryNinja via a plugin.
+Integrates OpenAI's GPT3 with BinaryNinja via a plugin. Creates a query asking
+"What does this function do?" followed by the instructions in the High Level IL
+function. Returns the response to the user in Binary Ninja's console.
 
 ## Installation
 
 If you're installing this as a standalone plugin, you can place (or sym-link)
 this in BinaryNinja's plugin path. Default paths are detailed on
 [Vector 35's documentation][default-plugin-dir].
 
+This plugin has been tested on macOS and Linux. It probably works on Windows;
+please submit a pull request if you've test it.
+
+### Dependencies
+
+- Python 3.10+
+- `openai` installed with `pip3 install --user openai`
+
 ## API Key
 
 This requires an [API token from OpenAI][token]. The plugin checks for the API
@@ -76,7 +86,7 @@ This project is licensed under the [MIT license][license].
 
 [default-plugin-dir]:https://docs.binary.ninja/guide/plugins.html
 [token]:https://beta.openai.com/account/api-keys
-[entry]:./entry.py
+[entry]:./src/entry.py
 [asyncio]:https://docs.python.org/3/library/asyncio.html
 [issue-8]:https://github.com/WhatTheFuzz/binaryninja-openai/issues/8
 [license]:./LICENSE

plugin.json

@@ -1,34 +1,32 @@
 {
-    "pluginmetadataversion": 1,
-    "name": "OpenAI",
-    "type": [
+   "pluginmetadataversion": 2,
+   "name": "OpenAI GPT3",
+   "author": "Sean Deaton (@WhatTheFuzz)",
+   "type": [
       "helper"
-    ],
-    "api": [
+   ],
+   "api": [
       "python3"
-    ],
-    "description": "Queries OpenAI to see what a function does in a given IL or pseudo-C.",
-    "longdescription": "",
-    "license": {
+   ],
+   "description": "Queries OpenAI's GPT3 to determine what a given function does.",
+   "longdescription": "Generates a query that asks 'What does this function do?' followed by a list of the instructions in the function. Returns the result from GPT3 and displays it to the user in the Binary Ninja console. Requires an OpenAI API key.",
+   "license": {
       "name": "MIT",
-      "text": "Copyright (c) 2022 Sean Deaton (@WhatTheFuzz)\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": [
+      "text": "Copyright 2022 Sean Deaton (@WhatTheFuzz)\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",
-      "Linux",
-      "Windows"
-    ],
-    "installinstructions": {
-      "Darwin": "pip3 install --user openai\nUnder your OpenAI account, create an API key and set it to the environment variable OPENAI_API_KEY; ie export OPENAI_API_KEY=<KEY_HERE>",
-      "Linux": "pip3 install --user openai\nUnder your OpenAI account, create an API key and set it to the environment variable OPENAI_API_KEY; ie export OPENAI_API_KEY=<KEY_HERE>",
-      "Windows": "You're on your own."
-    },
-    "dependencies": {
+      "Linux"
+   ],
+   "installinstructions": {
+      "Darwin": "pip3 install --user openai. Under your OpenAI account, create an API key and set it to the environment variable OPENAI_API_KEY inside Binary Ninja's Python console.",
+      "Linux": "pip3 install --user openai. Under your OpenAI account, create an API key and set it to the environment variable OPENAI_API_KEY inside Binary Ninja's Python console."
+   },
+   "dependencies": {
       "pip": [
-        "openai"
-      ],
-    },
-    "version": "1.0.0",
-    "author": "Sean Deaton (@WhatTheFuzz)",
-    "minimumbinaryninjaversion": 3164
-  }
+         "openai"
+      ]
+	},
+   "version": "1.0.0",
+   "minimumbinaryninjaversion": 3200
+}