Simple example of kicking off a Python script from GUI plugin with PyGhidra/Pyhidra?

[evm-sec]

For the CodeCut GUI plugin (https://github.com/JHUAPL/CodeCut) we kick off some Python scripts, we have two kinds, Jython, and Python 3. Our current approach to Python 3 is kicking off the native Python 3 executable in a separate process. We did this mostly for library dependencies (things only available in Python 3).

With Ghidra 11.3 I've started exploring PyGhidra/Pyhidra and specifically the script provider class (https://github.com/NationalSecurityAgency/ghidra/blob/master/Ghidra/Features/PyGhidra/src/main/java/ghidra/pyghidra/PyGhidraScriptProvider.java) - but I was curious if anybody has example code for how to do this. Is it as simple as making the script classes extend PyGhidraGhidraScript instead of JythonScript and defining a run() function that calls runScript()? (and I guess making sure you kick off Ghidra the new pyghidra way?)

Thanks in advance -- evm

[ryanmkurtz]

Here's how an Analyzer is calling a GhidraScript:

ghidra/Ghidra/Features/MicrosoftCodeAnalyzer/src/main/java/ghidra/app/plugin/prototype/MicrosoftCodeAnalyzerPlugin/WindowsResourceReferenceAnalyzer.java

Lines 86 to 103 in ecfd6d3

	ResourceFile sourceFile = GhidraScriptUtil.findScriptByName(scriptName);
	if (sourceFile == null) {
	throw new IllegalAccessException("Couldn't find script");
	}
	GhidraScriptProvider provider = GhidraScriptUtil.getProvider(sourceFile);
	if (provider == null) {
	throw new IllegalAccessException("Couldn't find script provider");
	}
	PrintWriter writer = getOutputMsgStream(tool);
	GhidraScript script = provider.getScriptInstance(sourceFile, writer);
	script.set(state, monitor, writer);
	// This code was added so the analyzer won't print script messages to console
	// This also adds the ability to pass the option to add or not add bookmarks to the script
	String[] scriptArguments = { "false", String.valueOf(createBookmarksEnabled) };
	script.runScript(scriptName, scriptArguments);

This method should be somewhat generic, in that Ghidra will be determining what type of script provider to use (java, jython, pyghidra, etc).

[evm-sec]

Ok yeah, that's more or less what we do right now with Jython - sounds like maybe it's just that easy. And I guess you can still package dependencies in the ghidra_scripts for the plugin.