Merge pull request #2 from WhatTheFuzz/feature/plugin-template

Feature/plugin template

Author: WhatTheFuzz

.gitignore

@@ -0,0 +1,2 @@
+*.DS_Store
+*.pyc

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Sean Deaton
+Copyright (c) 2022 Sean Deaton (@WhatTheFuzz)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,16 @@
-# binaryninja-openai
-Itegrates OpenAI with BinaryNinja via a plugin.
+# BinaryNinja-OpenAI
+
+Integrates OpenAI with BinaryNinja via a plugin.
+
+## 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].
+
+## License
+
+This project is licensed under the [MIT license][license].
+
+[default-plugin-dir]:https://docs.binary.ninja/guide/plugins.html
+[license]:./LICENSE

__init__.py

@@ -0,0 +1,8 @@
+from binaryninja import PluginCommand
+
+PluginCommand.register_for_address("What Does this Function Do?",
+                            "Checks OpenAI to see what this function does." \
+                            "Requires an internet connection and an API key "
+                            "saved under the environment variable "
+                            "OPENAI_API_KEY",
+                            TODO)

plugin.json

@@ -0,0 +1,34 @@
+{
+    "pluginmetadataversion": 1,
+    "name": "OpenAI",
+    "type": [
+      "helper"
+    ],
+    "api": [
+      "python3"
+    ],
+    "description": "Queries OpenAI to see what a function does in a given IL or pseudo-C.",
+    "longdescription": "",
+    "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": [
+      "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": {
+      "pip": [
+        "openai"
+      ],
+    },
+    "version": "1.0.0",
+    "author": "Sean Deaton (@WhatTheFuzz)",
+    "minimumbinaryninjaversion": 3164
+  }

requirements.txt

@@ -0,0 +1 @@
+openai