Consider protobuf for the message protocol - Githubissues

cyberkaida / reverse-engineering-assistant

An AI assistant for reverse engineering tasks 👩‍💻

Apache License 2.0

243 stars 20 forks source link

Consider protobuf for the message protocol #39

Closed cyberkaida closed 4 months ago

cyberkaida commented 6 months ago

Currently a custom JSON/Pydantic system is used for communication between the Java and Python sides.

This is because:

Including protobuf makes the build more complex
Including protobuf introduces a dependency on the Ghidra side
Pydantic is understood natively by langchain and is already a dependency

There are some problems with this:

The Java side requires a lot of boilerplate copy paste code
The registration of new entries is annoying, decorator/annotation/reflection does not work well

Some options:

Find a way to do reflection to locate the message classes
Add a generate step to generate the java from the python pydantic definition
Use something like protobuf

cyberkaida commented 6 months ago

It might not be difficult to have the Ghidra plugin import the message classes from python and generate the java classes. They are simple (for now), but if we do more nested types (like the RevaVariable type) this might be a problem when these are shared between messages...