Merge pull request #1 from psifertex/main

initial update for plugin manager

Author: nshp

README.md

@@ -1,2 +1,19 @@
-# binaryninja-printf
-Format string analysis plugin for BinaryNinja
+# Binary Ninja Printf Analysis
+
+Plugin to update the printf family of functions:
+
+ - printf
+ - wprintf
+ - fprintf
+ - dprintf
+ - sprintf
+ - asprintf
+ - snprintf
+ - __printf_chk
+ - __fprintf_chk
+ - __sprintf_chk
+ - __snprintf_chk
+
+ Can parse existing printf family of functions using the `Override printf call types` command-palette or plugin menu action. Uses the `set_call_type_adjustment` API along with a basic format string parser to appropriate type each location where one of those APIs is called.
+
+ Additionally, supports the ability to add additional custom printf-like functions and add new format specifiers. To add new specifiers, use the `Add printf extension` menu/action and to add new functions use the `Add printf-like function` menu/action.

printf/__init__.py renamed to __init__.py

@@ -582,7 +582,7 @@ def work_func(bv, func):
 
 PluginCommand.register(
     "Override printf call types",
-    "Properly types printfy calls by parsing format strings",
+    "Properly types printf-family calls by parsing format strings",
     work
 )
 

plugin.json

@@ -0,0 +1,30 @@
+{
+    "pluginmetadataversion": 2,
+    "name": "Format String Analysis",
+    "type": [
+        "analysis"
+    ],
+    "api": [
+        "python3"
+    ],
+    "description": "Script to automatically annotate variadic printf functions",
+    "license": {
+        "name": "MIT",
+        "text": "Copyright (c) 2022 Nick Shipp\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": "no special instructions, package manager is recommended",
+        "Linux": "no special instructions, package manager is recommended",
+        "Windows": "no special instructions, package manager is recommended"
+    },
+    "dependencies": {
+    },
+    "version": "1.0",
+    "author": "Nick Shipp",
+    "minimumbinaryninjaversion": 3814
+}