https://github.com/fmagin/ghidra-openai

Get Function Summaries and more for Ghidra from ChatGPT
https://github.com/fmagin/ghidra-openai

chatgpt ghidra

Last synced: about 1 year ago
JSON representation

Get Function Summaries and more for Ghidra from ChatGPT

• Host: GitHub
• URL: https://github.com/fmagin/ghidra-openai
• Owner: fmagin
• License: mit
• Created: 2022-12-03T11:32:37.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-06T10:25:45.000Z (over 3 years ago)
• Last Synced: 2025-03-18T21:16:02.224Z (about 1 year ago)
• Topics: chatgpt, ghidra
• Language: Kotlin
• Homepage:
• Size: 316 KB
• Stars: 30
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# OpenAI Integration for Ghidra

> Get Function Summaries from ChatGTP

## Installation

1. This plugin requires Kotlin language support in Ghidra, so make sure that you have it installed:

https://github.com/GhidraJupyter/ghidra-jupyter-kotlin/releases

2. Grab the latest release of this Plugin from the [releases page](https://github.com/fmagin/ghidra-openai/releases)

and install it in Ghidra.

## Usage

### Initial Setup

Configure your API Key via `Edit -> Tool Options -> OpenAI`

![img.png](imgs/API_key.png)

### GUI Integration

Right Click in the Decompiler, and select `Get and apply Function Summary via OpenAI`

Before:

![img.png](imgs/before.png)

After:

![img.png](imgs/after.png)

### Configuration

You can easily change the model used for the completions and its parameters via

the `Edit -> Tool Options -> OpenAI -> Model` menu.

![img.png](imgs/parameters.png)

The decompiled text will be appended to the prompt and will be sent as a completion request to the OpenAI API.

## Potential Future Work

No promises that I will ever implement them, but I'll gladly provide advice if you want to try:

* Dedicated Dialog that previews the function summary and allows retrying before applying

* Allow a custom prompt to be specified for a specific _program_ via the `Options for $program` menu

* Request better variable or function names like https://github.com/JusticeRage/Gepetto does