-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating to python3 compatibility and updating metadata for pluginmet…
…adataversion 2
- Loading branch information
Showing
4 changed files
with
342 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,327 @@ | ||
| #!/usr/bin/env python3 | ||
| """ | ||
| This script helps in the process of creating required metadata to add a plugin to the Binary Ninja plugin repository | ||
| """ | ||
| import json | ||
| import argparse | ||
| import os | ||
| import sys | ||
| import io | ||
| import datetime | ||
| import pprint | ||
| import tempfile | ||
| from builtins import input | ||
| import sys, tempfile, os | ||
| from subprocess import call | ||
|
|
||
| currentpluginmetadataversion = 2 | ||
|
|
||
| # def getEditorData(message): | ||
| # EDITOR = os.environ.get('EDITOR','vim') | ||
|
|
||
| # initial_message = message | ||
| # edited_message = "" | ||
| # with tempfile.NamedTemporaryFile(suffix=".tmp") as tf: | ||
| # tf.write(initial_message.encode("utf-8")) | ||
| # tf.flush() | ||
| # call([EDITOR, tf.name]) | ||
|
|
||
| # tf.seek(0) | ||
| # edited_message = tf.read().decode("utf-8") | ||
| # return edited_message | ||
|
|
||
| validPluginTypes = ["core", "ui", "binaryview", "architecture", "helper"] | ||
| validApis = ["python2", "python3"] | ||
| validPlatforms = ["Darwin", "Windows", "Linux"] | ||
| requiredLicenseKeys = ["name", "text"] | ||
|
|
||
| def validateList(data, name, validList): | ||
| if name not in data: | ||
| print("Warning: '{}' field doesn't exist".format(name)) | ||
| return False | ||
| elif not isinstance(data[name], list): | ||
| print("Error: '{}' field isn't a list".format(name)) | ||
| return False | ||
|
|
||
| success = True | ||
| for item in data[name]: | ||
| if item not in validList: | ||
| print("Error: plugin {}: {} not one of {}".format(name, item, validList)) | ||
| success = False | ||
| return success | ||
|
|
||
| def validateString(data, name): | ||
| if name not in data: | ||
| print("Error: '{}' field doesn't exist".format(name)) | ||
| return False | ||
| elif type(data[name]).__name__ not in ("unicode", "str"): # a python 2/3 compliant check for string type | ||
| print("Error: '{}' field is {} not a string".format(name, type(data[name]))) | ||
| return False | ||
| return True | ||
|
|
||
| def validateInteger(data, name): | ||
| if name not in data: | ||
| print("Error: '{}' field doesn't exist.".format(name)) | ||
| return False | ||
| elif not isinstance(data[name], int): | ||
| print("Error: '{}' is {} not an integer value".format(name, type(data[name]))) | ||
| return False | ||
| return True | ||
|
|
||
| def validateStringMap(data, name, validKeys, requiredKeys=None): | ||
| if name not in data: | ||
| print("Error: '{}' field doesn't exist.".format(name)) | ||
| return False | ||
| elif not isinstance(data[name], dict): | ||
| print("Error: '{}' is {} not a dict type".format(name, type(data[name]))) | ||
| return False | ||
|
|
||
| success = True | ||
| if requiredKeys is not None: | ||
| for key in requiredKeys: | ||
| if key not in data[name]: | ||
| print("Error: required subkey '{}' not in {}".format(key, name)) | ||
| success = False | ||
|
|
||
| for key in data[name].keys(): | ||
| if key not in validKeys: | ||
| print("Error: key '{}' not is not in the set of valid keys {}".format(key, validKeys)) | ||
| success = False | ||
|
|
||
| return success | ||
|
|
||
| def validateRequiredFields(data): | ||
| success = validateInteger(data, "pluginmetadataversion") | ||
| if success: | ||
| if data["pluginmetadataversion"] != currentpluginmetadataversion: | ||
| print("Error: 'pluginmetadataversion' is not the correct version") | ||
| success = False | ||
| else: | ||
| print("Current version is {}".format(currentpluginmetadataversion)) | ||
|
|
||
| success &= validateString(data, "name") | ||
| success &= validateList(data, "type", validPluginTypes) | ||
| success &= validateList(data, "api", validApis) | ||
| success &= validateString(data, "description") | ||
| success &= validateString(data, "longdescription") | ||
| success &= validateStringMap(data, "license", requiredLicenseKeys, requiredLicenseKeys) | ||
| validPlatformList = validateList(data, "platforms", validPlatforms) | ||
| success &= validPlatformList | ||
| success &= validateStringMap(data, "installinstructions", validPlatforms, list(data["platforms"]) if validPlatformList else None) | ||
| success &= validateString(data, "version") | ||
| success &= validateString(data, "author") | ||
| success &= validateInteger(data, "minimumbinaryninjaversion") | ||
| return success | ||
|
|
||
| def getCombinationSelection(validList, prompt, maxItems=None): | ||
| if maxItems == None: | ||
| maxItems = len(validList) | ||
|
|
||
| prompt2 = "Enter comma separated list of items> " | ||
| if maxItems == 1: | ||
| prompt2 = "> " | ||
| while True: | ||
| print(prompt) | ||
| for i, item in enumerate(validList): | ||
| print("\t{:>3}: {}".format(i, item)) | ||
| items = filter(None, input(prompt2).split(",")) | ||
| result = [] | ||
| success = True | ||
| for item in items: | ||
| try: | ||
| value = int(item.strip()) | ||
| except ValueError: | ||
| print("Couldn't convert {} to integer".format(item)) | ||
| success = False | ||
| break | ||
| if value < 0 or value >= len(validList): | ||
| print("{} is not a valid selection".format(value)) | ||
| success = False | ||
| break | ||
| else: | ||
| result.append(validList[value]) | ||
| if success: | ||
| return result | ||
|
|
||
| licenseTypes = { | ||
| "MIT" : """Permission 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.""", | ||
| "2-Clause BSD" : """Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.""", | ||
| "Apache-2.0" : """Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\n\thttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.""", | ||
| "LGPL-2.0" : """This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.\n\nThis library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA""", | ||
| "LGPL-2.1" : """This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.\n\nThis library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA""", | ||
| "LGPL-3.0" : """This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version.\n\nThis library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA""", | ||
| "GPL-2.0" : """This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with this program; if not, see <http://www.gnu.org/licenses/>.""", | ||
| "GPL-3.0" : """This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.""" | ||
| } | ||
|
|
||
| def generatepluginmetadata(): | ||
| data = {} | ||
| data["pluginmetadataversion"] = 2 | ||
| data["name"] = input("Enter plugin name: ") | ||
| data["author"] = input("Enter your name or the name you want this plugin listed under: ") | ||
| data["type"] = getCombinationSelection(validPluginTypes, "Which types of plugin is this? ") | ||
| data["api"] = getCombinationSelection(validApis, "Which api's are supported? ") | ||
| data["description"] = input("Enter a short description of this plugin (50 characters max): ") | ||
| data["longdescription"] = input("Enter a full description of this plugin (Markdown formatted): ") | ||
| data["license"] = {} | ||
|
|
||
| licenseTypeNames = ["Other"] | ||
| licenseTypeNames.extend(licenseTypes.keys()) | ||
| data["license"]["name"] = getCombinationSelection(licenseTypeNames, "Enter the license type of this plugin:", 1)[0] | ||
| if data["license"]["name"] == "Other": | ||
| data["license"]["name"] = input("Enter License Type: ") | ||
| data["license"]["text"] = input("Enter License Text: ") | ||
| else: | ||
| data["license"]["text"] = licenseTypes[data["license"]["name"]] | ||
|
|
||
| year = datetime.datetime.now().year | ||
| holder = data["author"] | ||
|
|
||
| answer = input("Is this the correct copyrigtht information?\n\tCopyright {year} {holder}\n[Y/n]: ".format(year=year, holder=holder)) | ||
| if answer not in ("Y", "y", ""): | ||
| year = input("Enter copyright year: ") | ||
| holder = input("Enter copyright holder: ") | ||
|
|
||
| data["license"]["text"] = "Copyright {year} {holder}\n\n".format(year=year, holder=holder) + data["license"]["text"] | ||
| data["platforms"] = getCombinationSelection(validPlatforms, "Which platforms are supported? ") | ||
|
|
||
| data["installinstructions"] = {} | ||
| for platform in data["platforms"]: | ||
| print("Enter Markdown formatted installation directions for the following platform: ") | ||
| data["installinstructions"][platform] = input("{}: ".format(platform)) | ||
| data["version"] = input("Enter the version string for this plugin. ") | ||
| data["minimumbinaryninjaversion"] = int(input("Enter the minimum build number that you've successfully tested this plugin with: ")) | ||
| return data | ||
|
|
||
|
|
||
| readmeTemplate = u"""# {name} (v{version}) | ||
| Author: **{author}** | ||
| _{description}_ | ||
| ## Description: | ||
| {longdescription} | ||
| {install} | ||
| ## Minimum Version\n\nThis plugin requires the following minimum version of Binary Ninja:\n\n * {minimum}\n" | ||
| {dependencies} | ||
| ## License\n\nThis plugin is released under a {license} license. | ||
| ## Metadata Version\n\n{metadataVersion}\n""" | ||
|
|
||
| def generateReadme(plugin): | ||
| install = None | ||
| if "installinstructions" in plugin: | ||
| install = "\n\n## Installation Instructions" | ||
| for platform in plugin["installinstructions"]: | ||
| install += "\n\n### {}\n\n{}".format(platform, plugin["installinstructions"][platform]) | ||
|
|
||
| if "dependencies" in plugin: | ||
| dependencies = u"\n\n## Required Dependencies\n\nThe following dependencies are required for this plugin:\n\n" | ||
| for dependency in plugin["dependencies"]: | ||
| dependencylist = u", ".join(plugin["dependencies"][dependency]) | ||
| dependencies += u" * {dependency} - {dependencylist}\n".format(dependency = dependency, dependencylist = dependencylist) | ||
| dependencies += "\n" | ||
| else: | ||
| dependencies = "" | ||
|
|
||
| return readmeTemplate.format(name=plugin["name"], version=plugin["version"], | ||
| author=plugin["author"], description=plugin["description"], | ||
| longdescription=plugin["longdescription"], install=install, | ||
| minimum=plugin["minimumbinaryninjaversion"], dependencies=dependencies, | ||
| license=plugin["license"]["name"], metadataVersion=plugin["pluginmetadataversion"]) | ||
|
|
||
|
|
||
| def main(): | ||
| parser = argparse.ArgumentParser(description="Generate README.md (and optional LICENSE) from plugin.json metadata") | ||
| parser.add_argument("-a", "--all", help="Generate all supporting information needed (plugin.json, README.md, LICENSE)", action="store_true") | ||
| parser.add_argument("-p", "--plugin", help="Interactively generate plugin.json file", action="store_true") | ||
| parser.add_argument("-r", "--readme", help="Automatically generate README.md", action="store_true") | ||
| parser.add_argument("-l", "--license", help="Automatically generate LICENSE file", action="store_true") | ||
| parser.add_argument("-f", "--force", help="Force overwrite of existing files", action="store_true") | ||
| parser.add_argument("-v", "--validate", help="Validate existing plugin.json only", metavar="JSON") | ||
| args = parser.parse_args() | ||
|
|
||
|
|
||
| # Just validate an existing plugin.json | ||
| if args.validate is not None: | ||
| if validateRequiredFields(json.load(io.open(args.validate, "r", encoding="utf8"))["plugin"]): | ||
| print("Successfully validated json file") | ||
| else: | ||
| print("Error: json validation failed") | ||
| return | ||
|
|
||
| pluginjson = "plugin.json" | ||
|
|
||
| # Enable all the options if --all is selected | ||
| if args.all: | ||
| args.plugin = True | ||
| args.readme = True | ||
| args.license = True | ||
|
|
||
| if args.plugin: | ||
| plugin = generatepluginmetadata() | ||
| else: | ||
| try: | ||
| plugin = json.load(io.open(pluginjson, "r", encoding="utf8"))["plugin"] | ||
| except json.JSONDecodeError: | ||
| print("File {} doesn't contain valid json".format(pluginjson)) | ||
| return | ||
| except Exception: | ||
| print("File {} doesn't exist".format(pluginjson)) | ||
| return | ||
|
|
||
| print("-----------------------------------------------------------------") | ||
| if validateRequiredFields(plugin): | ||
| print("Successfully validated json file") | ||
| else: | ||
| print("Error: json validation failed") | ||
| return | ||
|
|
||
| if "python2" in plugin["api"] and "python3" not in plugin["api"]: | ||
| print("Warning: This python plugin doesn't support python3, python2 support will soon be deprecated.") | ||
| print(" Please consider upgrading you plugin to support python3") | ||
|
|
||
| if args.plugin: | ||
| skip = False | ||
| print("-----------------------------------------------------------------") | ||
| if os.path.isfile(pluginjson) and not args.force and args.plugin: | ||
| print("{} already exists.".format(pluginjson)) | ||
| response = input("Overwrite it? (N,y) ") | ||
| if response != "y": | ||
| print("Not overwriting plugin.json") | ||
| skip = True | ||
| if not skip: | ||
| print("Creating plugin.json.") | ||
| with io.open(pluginjson, "w", encoding="utf8") as pluginfile: | ||
| pluginfile.write(json.dumps({"plugin": plugin}, indent=" ")) | ||
|
|
||
| if args.readme: | ||
| print("-----------------------------------------------------------------") | ||
| readme = os.path.join(os.path.dirname(pluginjson), "README.md") | ||
| skip = False | ||
| if os.path.isfile(readme) and not args.force: | ||
| print("{} already exists.".format(readme)) | ||
| response = input("Overwrite it? (N,y) ") | ||
| if response != "y": | ||
| print("Not overwriting README.md") | ||
| skip = True | ||
| if not skip: | ||
| print("Creating README.md") | ||
| with io.open(readme, "w", encoding="utf8") as readmeFile: | ||
| readmeFile.write(generateReadme(plugin)) | ||
|
|
||
| if args.license: | ||
| print("-----------------------------------------------------------------") | ||
| licenseFile = os.path.join(os.path.dirname(pluginjson), "LICENSE") | ||
| skip = False | ||
| if os.path.isfile(licenseFile) and not args.force: | ||
| print("{} already exists.".format(licenseFile)) | ||
| response = input("Overwrite it? (N,y) ") | ||
| if response != "y": | ||
| print("Not overwriting LICENSE") | ||
| skip = True | ||
| if not skip: | ||
| print("Creating LICENSE") | ||
| with io.open(licenseFile, "w", encoding="utf8") as lic: | ||
| lic.write(plugin["license"]["text"]) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() |
Oops, something went wrong.