Code Monkey home page Code Monkey logo

ghidrai's Introduction

GhidrAI

License

GhidrAI is a Ghidra extension which uses Alibaba Cloud LLM services explain what a function does, and to automatically rename its variables. Most importantly, these services are free :)

Requirements

The GhidrAI is verified on Ghidra 10.4. Note: Ghidra 10.4 requires JDK 17 64-bit.

Building GhidrAI

Use the following steps to build GhidrAI for your environment:

  • Install Ghidra using the documentation here
  • Install Gradle from here
  • Download the latest GhidrAI source release from here
  • Run the following command from the GhidrAI source directory:
    • Note: you may optionally set an environment variable named GHIDRA_INSTALL_DIR instead of specifying -PGHIDRA_INSTALL_DIR
$ gradle -PGHIDRA_INSTALL_DIR=<absolute path to Ghidra install>

This command builds GhidrAI. If successful, you will find a new directory in your GhidrAI source directory named dist containing your GhidrAI extension (.zip). Please open a new issue if you experience any issues. (Please provide the log file at ~/.ghidra/.ghidra_${VERSION}/application.log.)

Installing GhidrAI

Use the following steps to install your GhidrAI extension in Ghidra:

  • Note: For Alibaba Cloud DashScope, you must use the DASHSCOPE_API_KEY environment variable.
  • Start Ghidra
  • Navigate to File > Install Extensions...
  • Click the green + button
  • Navigate to your GhidrAI extension built earlier (.zip)
  • Click Ok
  • Restart Ghidra

OR

You can extract your GhidrAI extension (.zip) directly to <absolute path to Ghidra install>\Ghidra\Extensions and Ghidra will prompt you to configure GhidrAI the next time it is started.

Using GhidrAI

Select the function and right click the mouse, you can find the option in the menu.

Right click to reqeuest LLM service.

Click Tools > GhidrAI, and you can find the configruation dialog. For more detailed information, refer data/README.md.

Configuration dialog.

GhidrAI also provides an automatic analyzer, you can find it in Analysis > Auto Analyze ... or Analysis > One Shot.

Automatic analyzer

One shot analysis

Acknowledgment

This project refers to the Ghidrathon plugin, which provides out-of-box Python3 integrations for Ghidra. My original idea is to utilize Ghidrathon to run LLMs locally. But directly requesting services such as Alibaba Cloud DashScope saves my time.

And apparently the idea is from Gepetto.

ghidrai's People

Contributors

forsworns avatar

Stargazers

avatar

Watchers

avatar

ghidrai's Issues

Error creating class GhidraAnalyzer when creating extension points for ghidra.app.services.Analyzer

I compiled GhidrAI for Ghdira 11.0.2 (note that I had to remove line 106 in src/main/java/ghidrai/ui/GhidraiDialog.java because of illegal characters).

I installed the plugin and enabled it, however when starting ghidra on a target I get this error:

image

java.lang.reflect.InvocationTargetException
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
	at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:499)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:480)
	at ghidra.util.classfinder.ClassSearcher.getInstances(ClassSearcher.java:156)
	at ghidra.util.classfinder.ClassSearcher.getInstances(ClassSearcher.java:131)
	at ghidra.app.plugin.core.analysis.AutoAnalysisPlugin.findAnalyzers(AutoAnalysisPlugin.java:93)
	at ghidra.app.plugin.core.analysis.AutoAnalysisPlugin.<init>(AutoAnalysisPlugin.java:78)
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
	at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:499)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:480)
	at ghidra.framework.plugintool.util.PluginUtils.instantiatePlugin(PluginUtils.java:46)
	at ghidra.framework.plugintool.PluginManager.addPlugins(PluginManager.java:146)
	at ghidra.framework.plugintool.PluginManager.restorePluginsFromXml(PluginManager.java:314)
	at ghidra.framework.plugintool.PluginTool.restoreFromXml(PluginTool.java:628)
	at ghidra.framework.project.tool.GhidraTool.restoreFromXml(GhidraTool.java:136)
	at ghidra.framework.plugintool.PluginTool.<init>(PluginTool.java:140)
	at ghidra.framework.project.tool.GhidraTool.<init>(GhidraTool.java:67)
	at ghidra.framework.project.tool.GhidraToolTemplate.createTool(GhidraToolTemplate.java:215)
	at ghidra.framework.project.tool.ToolManagerImpl.getTool(ToolManagerImpl.java:651)
	at ghidra.framework.project.tool.WorkspaceImpl.runTool(WorkspaceImpl.java:79)
	at ghidra.framework.project.tool.ToolServicesImpl.defaultLaunch(ToolServicesImpl.java:211)
	at ghidra.framework.project.tool.ToolServicesImpl.launchTool(ToolServicesImpl.java:237)
	at ghidra.framework.main.ToolButton.openDomainFiles(ToolButton.java:564)
	at ghidra.framework.main.ToolButton$2.end(ToolButton.java:541)
	at ghidra.framework.main.ZoomImageRunner$1.end(ZoomImageRunner.java:54)
	at org.jdesktop.animation.timing.Animator.end(Animator.java:755)
	at org.jdesktop.animation.timing.Animator.stop(Animator.java:660)
	at org.jdesktop.animation.timing.Animator.timingEvent(Animator.java:732)
	at org.jdesktop.animation.timing.Animator.access$200(Animator.java:75)
	at org.jdesktop.animation.timing.Animator$TimerTarget.actionPerformed(Animator.java:1041)
	at java.desktop/javax.swing.Timer.fireActionPerformed(Timer.java:311)
	at java.desktop/javax.swing.Timer$DoPostEvent.run(Timer.java:243)
	at java.desktop/java.awt.event.InvocationEvent.dispatch(InvocationEvent.java:318)
	at java.desktop/java.awt.EventQueue.dispatchEventImpl(EventQueue.java:773)
	at java.desktop/java.awt.EventQueue$4.run(EventQueue.java:720)
	at java.desktop/java.awt.EventQueue$4.run(EventQueue.java:714)
	at java.base/java.security.AccessController.doPrivileged(AccessController.java:399)
	at java.base/java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:86)
	at java.desktop/java.awt.EventQueue.dispatchEvent(EventQueue.java:742)
	at java.desktop/java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:203)
	at java.desktop/java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:124)
	at java.desktop/java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:113)
	at java.desktop/java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:109)
	at java.desktop/java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:101)
	at java.desktop/java.awt.EventDispatchThread.run(EventDispatchThread.java:90)
Caused by: java.util.ServiceConfigurationError: ghidrai.services.ServiceInterface: Provider ghidrai.services.DashScopeService could not be instantiated
	at java.base/java.util.ServiceLoader.fail(ServiceLoader.java:586)
	at java.base/java.util.ServiceLoader$ProviderImpl.newInstance(ServiceLoader.java:813)
	at java.base/java.util.ServiceLoader$ProviderImpl.get(ServiceLoader.java:729)
	at java.base/java.util.ServiceLoader$3.next(ServiceLoader.java:1403)
	at ghidrai.services.GhidraiAgent.<clinit>(GhidraiAgent.java:30)
	at ghidrai.GhidraiAnalyzer.<init>(GhidraiAnalyzer.java:40)
	... 49 more
Caused by: java.lang.ExceptionInInitializerError
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
	at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:499)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:480)
	at java.base/java.util.ServiceLoader$ProviderImpl.newInstance(ServiceLoader.java:789)
	... 53 more
Caused by: java.lang.IllegalStateException: DashScope API key must be set via environment variable. Try `export DASHSCOPE_API_KEY=YOUR_DASHSCOPE_API_KEY`.
	at ghidrai.services.DashScopeService.<clinit>(DashScopeService.java:36)
	... 59 more

---------------------------------------------------
Build Date: 2024-Mar-26 1446 EDT
Ghidra Version: 11.0.2
Java Home: /usr/lib/jvm/java-17-openjdk-amd64
JVM Version: Private Build 17.0.10
OS: Linux 6.5.0-26-generic amd64

Is that an incompatibility with Ghidra 11?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.