0.3.0 release

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [0.3.0] - 2022-11-29
+- Added ability to install custom plugins from the launcher using `install_plugin()`.
+- Added ability to register entry_points for customizing launcher before starting up.
+
 ## [0.2.1] - 2022-11-03
 - Adds compatibility for Ghidra 10.2.
 
@@ -45,7 +49,8 @@
 ## 0.1.0 - 2021-06-14
 - Initial release
 
-[Unreleased]: https://github.com/dod-cyber-crime-center/pyhidra/compare/0.2.1...HEAD
+[Unreleased]: https://github.com/dod-cyber-crime-center/pyhidra/compare/0.3.0...HEAD
+[0.3.0]: https://github.com/dod-cyber-crime-center/pyhidra/compare/0.2.1...0.3.0
 [0.2.1]: https://github.com/dod-cyber-crime-center/pyhidra/compare/0.2.0...0.2.1
 [0.2.0]: https://github.com/dod-cyber-crime-center/pyhidra/compare/0.1.5...0.2.0
 [0.1.5]: https://github.com/dod-cyber-crime-center/pyhidra/compare/0.1.4...0.1.5

README.md

@@ -64,6 +64,58 @@ launcher.add_vmargs("-Dlog4j2.formatMsgNoLookups=true")
 launcher.start()
 ```
 
+### Registering an Entry Point
+
+The `PyhidraLauncher` can also be configured through the use of a registered entry point on your own python project.
+This is useful for installing your own Ghidra plugin which uses pyhidra and self-compiles.
+
+First create an [entry_point](https://setuptools.pypa.io/en/latest/userguide/entry_point.html) for `pyhidra.setup`
+pointing to a single argument function which accepts the launcher instance.
+
+```python
+# setup.py
+from setuptools import setup
+
+setup(
+    # ...,
+    entry_points={
+        'pyhidra.setup': [
+            'acme_plugin = acme.ghidra_plugin.install:setup',
+        ]
+    }
+)
+```
+
+
+Then we create the target function.
+This function will be called every time a user starts a pyhidra launcher.
+In the same fashion, another entry point `pyhidra.pre_launch` may be registered and will be called after Ghidra and all
+plugins have been loaded.
+
+```python
+# acme/ghidra_plugin/install.py
+from pathlib import Path
+import pyhidra
+
+def setup(launcher):
+    """
+    Run by pyhidra launcher to install our plugin.
+    """
+    launcher.add_classpaths("log4j-core-2.17.1.jar", "log4j-api-2.17.1.jar")
+    launcher.add_vmargs("-Dlog4j2.formatMsgNoLookups=true")
+
+    # Install our plugin.
+    source_path = Path(__file__).parent / "java" / "plugin"  # path to uncompiled .java code
+    details = pyhidra.ExtensionDetails(
+        name="acme_plugin",
+        description="My Cool Plugin",
+        author="acme",
+        plugin_version="1.2",
+    )
+    launcher.install_plugin(source_path, details)  # install plugin (if not already)
+```
+
+
 ### Analyze a File
 
 To have pyhidra setup a binary file for you, use the `open_program()` function.

pyhidra/__init__.py

@@ -1,13 +1,15 @@
 
-__version__ = "0.2.1"
+__version__ = "0.3.0"
 
 # Expose API
 from .ghidra import run_script, start, open_program
 from .script import get_current_interpreter
 from .launcher import DeferredPyhidraLauncher, HeadlessPyhidraLauncher, GuiPyhidraLauncher
+from .version import ExtensionDetails
 
 
 __all__ = [
     "run_script", "start", "open_program",
-    "DeferredPyhidraLauncher", "HeadlessPyhidraLauncher", "GuiPyhidraLauncher"
+    "DeferredPyhidraLauncher", "HeadlessPyhidraLauncher", "GuiPyhidraLauncher",
+    "ExtensionDetails",
 ]

pyhidra/__main__.py

@@ -1,5 +1,7 @@
 import argparse
 import code
+import logging
+
 import sys
 from pathlib import Path
 
@@ -196,6 +198,7 @@ def main():
     """
     pyhidra module main function
     """
+    logging.basicConfig(level=logging.INFO)
     parser = _get_parser()
     parser.parse_args(namespace=PyhidraArgs(parser)).func()
 

pyhidra/gui.py

@@ -1,13 +1,18 @@
-import contextlib
+
+import logging
 import os
 import platform
 import sys
 import warnings
 
 from pyhidra import get_current_interpreter as _get_current_interpreter
 
+logger = logging.getLogger(__name__)
+
 
 def _gui():
+    logging.basicConfig(level=logging.INFO)
+
     if platform.system() == 'Windows':
         # gui_script works like it is supposed to on windows
         gui()

pyhidra/java/plugin/__init__.py

@@ -1,4 +1,3 @@
 """
 Internal use only
-"""
-from .handler import install
+"""

pyhidra/java/plugin/plugin.py

@@ -1,6 +1,7 @@
 import contextlib
 import ctypes
 import itertools
+import logging
 import rlcompleter
 import sys
 import threading
@@ -11,15 +12,18 @@
 from ghidra.framework import Application
 from java.io import BufferedReader, InputStreamReader, PushbackReader
 from java.lang import ClassLoader, Runnable, String
+from java.util import Collections
 from java.util.function import Consumer
 from jpype import JClass, JImplements, JOverride
 from resources import ResourceManager
-from utility.function import Callback
 
 from pyhidra.java.plugin.completions import PythonCodeCompleter
 from pyhidra.script import PyGhidraScript
 
 
+logger = logging.getLogger(__name__)
+
+
 def _get_private_class(path: str) -> JClass:
     gcl = ClassLoader.getSystemClassLoader()
     return JClass(path, loader=gcl)
@@ -173,6 +177,7 @@ def __init__(self, plugin):
             return
         self._plugin = plugin
         self._actions = None
+        self._logged_completions_change = False
         plugin_cls = _get_plugin_class()
         _set_field(plugin_cls, "finalizer", Runnable @ self.dispose, plugin)
         self.console = PyConsole(self)
@@ -219,8 +224,20 @@ def service(self):
         return self._plugin.getTool().getService(InterpreterPanelService.class_)
 
     @JOverride
-    def getCompletions(self, cmd: str):
-        return self.completer.get_completions(cmd)
+    def getCompletions(self, *args):
+        try:
+            if len(args) == 2:
+                line, pos = args
+                line = line[:pos]
+            else:
+                # older versions of Ghidra don't have the `end` argument.
+                line, = args
+            return self.completer.get_completions(line)
+        except Exception as e:
+            if not self._logged_completions_change:
+                self._logged_completions_change = True
+                logger.exception(e)
+            return Collections.emptyList()
 
     @JOverride
     def getIcon(self):