Ghidra MCP Zig

🚀 Ghidra MCP Zig Plugin

The Ghidra MCP Zig Plugin is a comprehensive project that combines the Ghidra debugger with the Zig programming language. It aims to enhance Ghidra's reverse engineering and static analysis capabilities by providing functions such as function decompilation, renaming, and other advanced features.

🚀 Quick Start

1. Launch Ghidra and open the program to be analyzed.
2. The plugin will appear in Ghidra's plugin manager.
3. Use the plugin's features through the Ghidra interface.

✨ Features

• JNI Bridging: Enables communication between Zig and Java.
• Analysis Logic: Handles core functions like function decompilation and renaming.
• Server Implementation: Provides an interface for remote command execution.

📦 Installation

Prerequisites

Ensure the following software is installed:

• Zig Programming Language
• Ghidra Debugger
• JDK 17
• CMake

Enable mixed exports in CMakeLists.txt for cross - platform compatibility:

set(CMAKE_MIXED_EXPORTS TRUE)

Steps

1. Compile the plugin:

   make build-plugin
   

2. Copy the generated plugin to Ghidra's plugin directory:

   cp zig-out/lib/libghidra-mcp-zig.dylib /path/to/ghidra/Extensions/Ghidra/ghidra-mcp-zig/
   

3. Restart Ghidra.

💻 Usage Examples

Available Commands

• Decompile a function: decompile
• Rename a function: rename_function
• Rename data: rename_data
• List all functions: list_functions
• List all data: list_data
• List imports: list_imports
• List exports: list_exports

📚 Documentation

Error Handling

The plugin provides various error types to assist with debugging:

• ConnectionError: Issues related to connections.
• MessageError: Errors in message handling.
• ResponseError: Failures in response parsing.

Development and Debugging

1. Update the JNI bridge implementation:

   src/plugin/jni/bridge.zig
   

2. Implement corresponding features:

   src/plugin/analysis.zig
   

3. If you need to update the server logic:

   src/server/main.zig
   

Contribution Guidelines

1. Fork the project.
2. Create a new feature branch.
3. Commit your changes.
4. Push to the branch.
5. Submit a Pull Request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.