Port Ghidra Plugin to Support Ghidra 11.3.1 (#108)

* Port Ghidra Plugin to Support Ghidra 11.3.1

A bunch of things were deprecated (ProgramEvents) and some small nits are added.

* move builder to 11.3.1

* bump to gradle 8.5

* move Java to 21 *corsses fingers*

* bump ghidra in readme

* bump d2d version

---------

Co-authored-by: mahaloz <[email protected]>

Author: Jojeker

.github/workflows/ghidra-build.yml

@@ -1,9 +1,9 @@
 name: Ghidra Extension Build
 
 env:
-  ghidra-url: https://github.com/NationalSecurityAgency/ghidra/releases/download/Ghidra_10.3.2_build/ghidra_10.3.2_PUBLIC_20230711.zip
-  ghidra-zip-filename: ghidra_10.3.2_PUBLIC.zip
-  ghidra-directory: ghidra_10.3.2_PUBLIC
+  ghidra-url: https://github.com/NationalSecurityAgency/ghidra/releases/download/Ghidra_11.3.1_build/ghidra_11.3.1_PUBLIC_20250219.zip
+  ghidra-zip-filename: ghidra_11.3.1_PUBLIC.zip
+  ghidra-directory: ghidra_11.3.1_PUBLIC
 
 on:
   workflow_run:
@@ -37,19 +37,19 @@ jobs:
         args: unzip -qq ${{ steps.download-ghidra.outputs.file-path }} -d .
     - uses: actions/setup-java@v1
       with:
-        java-version: '17.0.6'
+        java-version: '21'
 
     - name: Build extension
       uses: eskatos/gradle-command-action@v1
       with:
-        gradle-version: '7.3'
+        gradle-version: '8.5'
         build-root-directory: ${{ github.workspace }}/decompilers/d2d_ghidra/
         arguments: '-PGHIDRA_INSTALL_DIR=${{ github.workspace }}/${{ env.ghidra-directory }}'
 
     - name: Rename extension
       run: cd decompilers/d2d_ghidra/dist/ && mv *.zip d2d-ghidra-plugin.zip
     - name: Upload built extension
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v4
       with:
         name: extension
         path: decompilers/d2d_ghidra/dist/d2d-ghidra-plugin.zip
@@ -61,7 +61,7 @@ jobs:
 
     steps:
     - name: Download built extension
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v4
       with:
         name: extension
     - name: Upload To Github Release

README.md

@@ -21,7 +21,7 @@ For active help, join the BinSync Discord below, where we answer decomp2dbg ques
 ### Decompilers
 - IDA Pro (>= 7.0): [Demo w/ GEF](https://asciinema.org/a/442740)
 - Binary Ninja (>= 2.4): [Demo w/ GEF](https://t.co/M2IZd0fmi3)
-- Ghidra (>= 10.1): [Demo w/ GEF](https://youtu.be/MK7N7uQTUNY)
+- Ghidra (>= 11.3.1): [Demo w/ GEF](https://youtu.be/MK7N7uQTUNY)
 - [angr-management](https://github.com/angr/angr-management) (>= 9.0)
 
 ### Debuggers

decomp2dbg/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.9.6"
+__version__ = "3.10.0"
 
 try:
     from .clients.client import DecompilerClient

decompilers/d2d_ghidra/src/main/java/decomp2dbg/D2DGhidraProcessorFactoryFactory.java

@@ -12,12 +12,14 @@ public D2DGhidraProcessorFactoryFactory(D2DGhidraServerAPI api) {
 		this.api = api;
 	}
 
+	@Override
 	public RequestProcessorFactory getRequestProcessorFactory(Class aClass) 
 			throws XmlRpcException {
 		return factory;
 	}
 
 	private class D2DGhidraProcessorFactory implements RequestProcessorFactory {
+		@Override
 		public Object getRequestProcessor(XmlRpcRequest xmlRpcRequest)
 				throws XmlRpcException {
 			return api;

decompilers/d2d_ghidra/src/main/java/decomp2dbg/D2DGhidraServerAPI.java

@@ -9,13 +9,15 @@
 import ghidra.app.util.bin.MemoryByteProvider;
 import ghidra.app.util.bin.format.elf.ElfException;
 import ghidra.app.util.bin.format.elf.ElfHeader;
+import ghidra.program.model.data.DataTypeComponent;
 import ghidra.program.model.listing.Function;
+import ghidra.program.model.listing.FunctionIterator;
 import ghidra.program.model.symbol.Symbol;
 import ghidra.program.model.symbol.SymbolType;
 import ghidra.util.Msg;
 
 public class D2DGhidraServerAPI {
-    private D2DGhidraServer server;
+    private final D2DGhidraServer server;
 
 	public D2DGhidraServerAPI(D2DGhidraServer server) {
 		this.server = server;
@@ -48,7 +50,7 @@ public Map<String, Object> decompile(Integer addr) {
 
 		var rebasedAddr = this.server.plugin.rebaseAddr(addr, false);
 		var func = this.server.plugin.getNearestFunction(rebasedAddr);
-		var rebasedAddrLong = rebasedAddr.getOffset();
+		long rebasedAddrLong = rebasedAddr.getOffset();
 
 		if(func == null) {
 			Msg.warn(server, "Failed to find a function by the address " + addr);
@@ -68,7 +70,7 @@ public Map<String, Object> decompile(Integer addr) {
 	    resp.put("decompilation", decLines);
 
 		PrettyPrinter pp = new PrettyPrinter(func, dec.getCCodeMarkup(), null);
-	    ArrayList<ClangLine> lines = pp.getLines();
+	    ArrayList<ClangLine> lines = (ArrayList<ClangLine>) pp.getLines();
 
 	    // locate the decompilation line
 	    Boolean lineFound = false;
@@ -119,7 +121,7 @@ public Map<String, Object> function_headers() {
 		Map<String, Object> resp = new HashMap<>();
 		var program = this.server.plugin.getCurrentProgram();
 		var fm = program.getFunctionManager();
-		var functions = fm.getFunctions(true);
+		FunctionIterator functions = fm.getFunctions(true);
 		for (Function func : functions) {
 		    if(func == null)
                 continue;
@@ -175,7 +177,7 @@ public Map<String, Object> structs() {
 			Map<String, Object> structInfo = new HashMap<>();
 			structInfo.put("name", struct.getName());
 			// Enumerate members
-			var members = struct.getComponents();
+			DataTypeComponent[] members = struct.getComponents();
 			// For unknown reasons, the API claims that some targets have structures with a crazy number of members (in the millions).
 			// This causes an infinite loop.
 			// May be caused by a bug in some other plugin, not sure.
@@ -262,7 +264,7 @@ public Map<String, Object> unions() {
 			Map<String, Object> unionInfo = new HashMap<>();
 			unionInfo.put("name", union.getName());
 			// Enumerate members
-			var members = union.getComponents();
+			DataTypeComponent[] members = union.getComponents();
 			ArrayList<Object> memberInfo = new ArrayList<>();
 			for (var member : members) {
 				Map<String, Object> memberData = new HashMap<>();
@@ -338,7 +340,7 @@ public Map<String, Object> elf_info() {
 
 		var program = this.server.plugin.getCurrentProgram();
 		var provider = new MemoryByteProvider(program.getMemory(), program.getMinAddress());
-		ElfHeader header = null;
+		ElfHeader header;
 		try {
 			header = new ElfHeader(provider, null);
 		}

decompilers/d2d_ghidra/src/main/java/decomp2dbg/D2DPlugin.java

@@ -32,8 +32,8 @@
 import ghidra.program.model.listing.Function;
 import ghidra.program.model.listing.Program;
 import ghidra.program.model.pcode.HighSymbol;
-import ghidra.program.util.ChangeManager;
 import ghidra.program.util.ProgramChangeRecord;
+import ghidra.program.util.ProgramEvent;
 import ghidra.util.Msg;
 import ghidra.util.task.ConsoleTaskMonitor;
 
@@ -125,8 +125,8 @@ private void configureD2DServer() {
 		};
 
 		int option = JOptionPane.showConfirmDialog(null, message, "Login", JOptionPane.OK_CANCEL_OPTION);
-		String host = null;
-		int port = 0;
+		String host;
+		int port;
 		if (option == JOptionPane.OK_OPTION) {
 			host = hostField.getText();
 			try {
@@ -218,7 +218,7 @@ public Map<String, Object> getFuncData(Integer addr) {
 			return funcInfo;
 		}
 
-		ArrayList<HighSymbol> symbols = new ArrayList<HighSymbol>();
+		ArrayList<HighSymbol> symbols = new ArrayList<>();
 		Map<String, Object> regVars = new HashMap<>();
 		Map<String, Object> stackVars = new HashMap<>();
 		dec.getHighFunction().getLocalSymbolMap().getSymbols().forEachRemaining(symbols::add);
@@ -251,38 +251,38 @@ public void domainObjectChanged(DomainObjectChangedEvent ev) {
 		// also look at:
 		// https://github.com/NationalSecurityAgency/ghidra/blob/master/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/AutoAnalysisManager.java
 
-		ArrayList<Integer> funcEvents = new ArrayList<>(Arrays.asList(
-			ChangeManager.DOCR_FUNCTION_CHANGED,
-			ChangeManager.DOCR_FUNCTION_BODY_CHANGED,
-			ChangeManager.DOCR_VARIABLE_REFERENCE_ADDED,
-			ChangeManager.DOCR_VARIABLE_REFERENCE_REMOVED
+		ArrayList<ProgramEvent> funcEvents = new ArrayList<>(Arrays.asList(
+			ProgramEvent.FUNCTION_CHANGED,
+			ProgramEvent.FUNCTION_BODY_CHANGED,
+			ProgramEvent.VARIABLE_REFERENCE_ADDED,
+			ProgramEvent.VARIABLE_REFERENCE_REMOVED
 		));
 
-		ArrayList<Integer> symDelEvents = new ArrayList<>(Arrays.asList(
-			ChangeManager.DOCR_SYMBOL_REMOVED	
+		ArrayList<ProgramEvent> symDelEvents = new ArrayList<>(Arrays.asList(
+			ProgramEvent.SYMBOL_REMOVED	
 		));
 
-		ArrayList<Integer> symChgEvents = new ArrayList<>(Arrays.asList(
-			ChangeManager.DOCR_SYMBOL_ADDED,
-			ChangeManager.DOCR_SYMBOL_RENAMED,
-			ChangeManager.DOCR_SYMBOL_DATA_CHANGED
+		ArrayList<ProgramEvent> symChgEvents = new ArrayList<>(Arrays.asList(
+			ProgramEvent.SYMBOL_ADDED,
+			ProgramEvent.SYMBOL_RENAMED,
+			ProgramEvent.SYMBOL_DATA_CHANGED
 		));
 
-		ArrayList<Integer> typeEvents = new ArrayList<>(Arrays.asList(
-			ChangeManager.DOCR_DATA_TYPE_CHANGED,
-			ChangeManager.DOCR_DATA_TYPE_REPLACED,
-			ChangeManager.DOCR_DATA_TYPE_RENAMED,
-			ChangeManager.DOCR_DATA_TYPE_SETTING_CHANGED,
-			ChangeManager.DOCR_DATA_TYPE_MOVED,
-			ChangeManager.DOCR_DATA_TYPE_ADDED
+		ArrayList<ProgramEvent> typeEvents = new ArrayList<>(Arrays.asList(
+			ProgramEvent.DATA_TYPE_CHANGED,
+			ProgramEvent.DATA_TYPE_REPLACED,
+			ProgramEvent.DATA_TYPE_RENAMED,
+			ProgramEvent.DATA_TYPE_SETTING_CHANGED,
+			ProgramEvent.DATA_TYPE_MOVED,
+			ProgramEvent.DATA_TYPE_ADDED
 		));
 
 		for (DomainObjectChangeRecord record : ev) {
 			// only analyze changes to the current program 
 			if( !(record instanceof ProgramChangeRecord) )
 				continue;
 
-			int chgType = record.getEventType();
+			ProgramEvent chgType = (ProgramEvent) record.getEventType();
 			var pcr = (ProgramChangeRecord) record;
 			var obj = pcr.getObject();
 			var newVal = pcr.getNewValue();
@@ -336,11 +336,11 @@ else if (symChgEvents.contains(chgType)) {
 				/*
 				 * GlobalVar & Label
 				 */
-				else if(obj instanceof CodeSymbol) {
+				else if(obj instanceof CodeSymbol codeSymbol) {
 					if(this.gVarCache.isEmpty())
 						continue;
 
-					var sym = (CodeSymbol) obj;
+					var sym = codeSymbol;
 					var newName = sym.getName();
 					var addr = sym.getAddress().getOffset();
 
@@ -353,11 +353,11 @@ else if(obj instanceof CodeSymbol) {
 				/*
 				 * Function Name
 				 */
-				else if(obj instanceof FunctionSymbol) {
+				else if(obj instanceof FunctionSymbol functionSymbol) {
 					if(this.funcSymCache.isEmpty())
 						continue;
 
-					var sym = (FunctionSymbol) obj;
+					var sym = functionSymbol;
 					var newName = sym.getName();
 					var addr = sym.getAddress().getOffset();