reverse-engineering-assistant 1.0.1__tar.gz → 2.9.1__tar.gz

{reverse-engineering-assistant-1.0.1 → reverse_engineering_assistant-2.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: reverse-engineering-assistant
-Version: 1.0.1
+Version: 2.9.1
 Summary: An AI assistant for reverse engineering tasks
 Author: サイバーカイダ (cyberkaida)
 Classifier: License :: OSI Approved :: Apache Software License
@@ -11,17 +11,17 @@ Description-Content-Type: text/markdown
 Requires-Dist: langchain
 Requires-Dist: langchain-core
 Requires-Dist: langchain-openai
-Requires-Dist: llama-cpp-python
 Requires-Dist: prompt_toolkit
 Requires-Dist: sentence_transformers
 Requires-Dist: PyYAML
 Requires-Dist: pydantic
 Requires-Dist: rich
-Requires-Dist: Flask
+Requires-Dist: grpcio
+Requires-Dist: protobuf
 
 # ReVA - Reverse Engineering Assistant
 
-[✨ An (old) quick demo! ✨](https://asciinema.org/a/626197)
+> Updated demo coming soon!
 
 The reverse engineering assistant (ReVA) is a project to build a disassembler agnostic AI assistant for
 reverse engineering tasks. This includes both _offline_ and online inference and a simple architecture.
@@ -68,16 +68,13 @@ Built in support is provided for:
 - [OpenAI](https://platform.openai.com/overview) for online inference and easy setup (Needs an OpenAI API key)
 - [Ollama](https://ollama.ai) and any model it supports for local on-device inference or connecting to a self hosted remote inference server.
 
-Limited support is provided for:
-- [llama-cpp](https://llama-cpp-python.readthedocs.io/en/latest/) and any model it supports for local on-device inference
-- [text-generation-webui](https://github.com/oobabooga/text-generation-webui) and any model it supports for self-hosted remote inference
-
 Adding additional inference servers is easy if it is supported by langchain.
 
-See the configuration section for more information about setting the model.
-
 ## Configuration
 
+> This is currently being moved to the Ghidra GUI
+> See Edit -> Tool Options -> ReVa in the Codebrowser Tool
+
 Configuration for the reverse engineering assistant is stored at
 `~/.config/reverse-engineering-assistant/config.yaml`. If this
 is not present on first start, a default configuration using
@@ -106,52 +103,47 @@ RevA has a two step workflow.
 2. Open the chat session.
 
 ReVa uses an extension for your RE tool to perform analysis.
-See [Ghidra Support](#ghidra-support) and [BinaryNinja Support](#binary-ninja-support) below.
-
-Once open the RE tool will try to connect to ReVa's REST API on localhost.
-
-A project cache is created in `~/.cache/reverse-engineering-assistant/projects`. This contains your chat log and other
-cache data. This can be deleted at any time and ReVa will re-generate the data as needed.
-
-To ask questions and run the inference a command line tool is provided. Run `revassistant --project ${NAME_OF_YOUR_FILE}` to begin the chat session.
+See [Ghidra Support](#ghidra-support) below.
 
-> Note: In the future `--project` will refer to a _project_ in Ghidra and allow inference across multiple files.
-> I am waiting for BinaryNinja's project feature to make this change, if this takes too long I will rework this argument.
+To ask questions and run the inference a command line tool is provided. Run `reva-chat` to begin the chat session. This command will find your open Ghidra
+and connect to it. To open a new chat, run the command again in another terminal.
 
-`revassistant` provides a chat window and runs the command API to talk with the RE tool.
-
-> Note: Right now only one `revassistant` can run at a time (as we start a server on a well known port)
-> In the future we will share the server between chat clients and RE tool connections.
+If you have more than one Ghidra open, you can select the right one with
+`reva-chat --project ${project-name}`, if it is not set, `reva-chat` will
+ask you which project you want to connect to.
 
 ## Installation
 
+First install the python component, I like to use `pipx`. It is best to make
+sure that `reva-server` and `reva-chat` are on your path.
+The Ghidra extension will need to start `reva-server`, and you will need to
+run `reva-chat`.
+
 To install the particular extension for your disassembler see:
 - [Ghidra Support](#ghidra-support)
-- [Binary Ninja Support](#binary-ninja-support)
-
-To install the chat component you can do the following:
-
-```sh
-python3 -m pip install ./reverse-engineering-assistant
-```
 
 The chat can be started with:
 
 ```sh
-revassistant --project ${NAME_OF_YOUR_PROJECT}
+reva-chat
 ```
 
+> You can also configure the path to `reva-server` in `Edit -> Tool Options -> ReVa`
+> if it is not on your path. But you really should put it on your path!
+
 # Ghidra Support
 
 ## Usage
 
+> The Python package must be installed for the Ghidra extension to work!
+
+Follow the instructions in the [ghidra-assistant](ghidra-assistant/README.md) plugin.
+
 After installation, enable the `ReVaPlugin` extension in the CodeBrowser tool (Open a file and click: File -> Configure -> Miscellaneous).
 
 If you want ReVa enabled by default, click File -> Save Tool to save the configuration.
 
-To start the inference side, open Help -> About ${program name}. In this popup you will see details about your open file.
-The `Program Name:` field is the name you need to pass to `revassistant --project` to start the inference server. In some
-cases this is different to the name in the project view.
+If everything is working correctly you will see a ReVa menu on your menu bar.
 
 ## Undo
 
@@ -160,6 +152,8 @@ one undo.
 
 ## Menus
 
+> These are being added in the next release
+
 ReVa adds some elements to the Ghidra UI. You can either ask ReVa to do something in the chat window,
 "Examine the variable usage in `main` in detail, rename the variables with more descriptive names.",
 or use the menu system.
@@ -167,22 +161,6 @@ or use the menu system.
 For example you can right click a variable in the decompilation, select Reva -> Rename variable and ReVa
 will perform the action.
 
-Note this uses the same system as chatting with ReVa, this means you can monitor ReVas thoughts in the chat
-window while the action is performed.
-
-# Binary Ninja Support
-
-> Note: Binary Ninja support is currently on hold while the basic functions are implemented in the Ghidra plugin.
-> This is because plugin development for Binary Ninja is easier as we have Python3. I will resume development soon!
-
-Install the ReVA BinaryNinja plugin by opening your BinaryNinja plugin directory (Plugins -> Open Plugin Folder)
-and copying or symbolic linking the [binary-ninja-assistant](./binary-ninja-assistant) directory into the plugin
-directory.
-
-Restart Binary Ninja and "ReVA Push" will be available in the Plugin menu.
-Press this to push data from BinaryNinja to ReVA, then follow the instructions in the [Workflow section](#workflow).
-The project name will be the name of the current open file.
-
 # Support
 
 Do you like my work? Want to support this project and others? Interested in how this project was designed and built?

{reverse-engineering-assistant-1.0.1 → reverse_engineering_assistant-2.9.1}/README.md

@@ -1,6 +1,6 @@
 # ReVA - Reverse Engineering Assistant
 
-[✨ An (old) quick demo! ✨](https://asciinema.org/a/626197)
+> Updated demo coming soon!
 
 The reverse engineering assistant (ReVA) is a project to build a disassembler agnostic AI assistant for
 reverse engineering tasks. This includes both _offline_ and online inference and a simple architecture.
@@ -47,16 +47,13 @@ Built in support is provided for:
 - [OpenAI](https://platform.openai.com/overview) for online inference and easy setup (Needs an OpenAI API key)
 - [Ollama](https://ollama.ai) and any model it supports for local on-device inference or connecting to a self hosted remote inference server.
 
-Limited support is provided for:
-- [llama-cpp](https://llama-cpp-python.readthedocs.io/en/latest/) and any model it supports for local on-device inference
-- [text-generation-webui](https://github.com/oobabooga/text-generation-webui) and any model it supports for self-hosted remote inference
-
 Adding additional inference servers is easy if it is supported by langchain.
 
-See the configuration section for more information about setting the model.
-
 ## Configuration
 
+> This is currently being moved to the Ghidra GUI
+> See Edit -> Tool Options -> ReVa in the Codebrowser Tool
+
 Configuration for the reverse engineering assistant is stored at
 `~/.config/reverse-engineering-assistant/config.yaml`. If this
 is not present on first start, a default configuration using
@@ -85,52 +82,47 @@ RevA has a two step workflow.
 2. Open the chat session.
 
 ReVa uses an extension for your RE tool to perform analysis.
-See [Ghidra Support](#ghidra-support) and [BinaryNinja Support](#binary-ninja-support) below.
-
-Once open the RE tool will try to connect to ReVa's REST API on localhost.
-
-A project cache is created in `~/.cache/reverse-engineering-assistant/projects`. This contains your chat log and other
-cache data. This can be deleted at any time and ReVa will re-generate the data as needed.
-
-To ask questions and run the inference a command line tool is provided. Run `revassistant --project ${NAME_OF_YOUR_FILE}` to begin the chat session.
+See [Ghidra Support](#ghidra-support) below.
 
-> Note: In the future `--project` will refer to a _project_ in Ghidra and allow inference across multiple files.
-> I am waiting for BinaryNinja's project feature to make this change, if this takes too long I will rework this argument.
+To ask questions and run the inference a command line tool is provided. Run `reva-chat` to begin the chat session. This command will find your open Ghidra
+and connect to it. To open a new chat, run the command again in another terminal.
 
-`revassistant` provides a chat window and runs the command API to talk with the RE tool.
-
-> Note: Right now only one `revassistant` can run at a time (as we start a server on a well known port)
-> In the future we will share the server between chat clients and RE tool connections.
+If you have more than one Ghidra open, you can select the right one with
+`reva-chat --project ${project-name}`, if it is not set, `reva-chat` will
+ask you which project you want to connect to.
 
 ## Installation
 
+First install the python component, I like to use `pipx`. It is best to make
+sure that `reva-server` and `reva-chat` are on your path.
+The Ghidra extension will need to start `reva-server`, and you will need to
+run `reva-chat`.
+
 To install the particular extension for your disassembler see:
 - [Ghidra Support](#ghidra-support)
-- [Binary Ninja Support](#binary-ninja-support)
-
-To install the chat component you can do the following:
-
-```sh
-python3 -m pip install ./reverse-engineering-assistant
-```
 
 The chat can be started with:
 
 ```sh
-revassistant --project ${NAME_OF_YOUR_PROJECT}
+reva-chat
 ```
 
+> You can also configure the path to `reva-server` in `Edit -> Tool Options -> ReVa`
+> if it is not on your path. But you really should put it on your path!
+
 # Ghidra Support
 
 ## Usage
 
+> The Python package must be installed for the Ghidra extension to work!
+
+Follow the instructions in the [ghidra-assistant](ghidra-assistant/README.md) plugin.
+
 After installation, enable the `ReVaPlugin` extension in the CodeBrowser tool (Open a file and click: File -> Configure -> Miscellaneous).
 
 If you want ReVa enabled by default, click File -> Save Tool to save the configuration.
 
-To start the inference side, open Help -> About ${program name}. In this popup you will see details about your open file.
-The `Program Name:` field is the name you need to pass to `revassistant --project` to start the inference server. In some
-cases this is different to the name in the project view.
+If everything is working correctly you will see a ReVa menu on your menu bar.
 
 ## Undo
 
@@ -139,6 +131,8 @@ one undo.
 
 ## Menus
 
+> These are being added in the next release
+
 ReVa adds some elements to the Ghidra UI. You can either ask ReVa to do something in the chat window,
 "Examine the variable usage in `main` in detail, rename the variables with more descriptive names.",
 or use the menu system.
@@ -146,22 +140,6 @@ or use the menu system.
 For example you can right click a variable in the decompilation, select Reva -> Rename variable and ReVa
 will perform the action.
 
-Note this uses the same system as chatting with ReVa, this means you can monitor ReVas thoughts in the chat
-window while the action is performed.
-
-# Binary Ninja Support
-
-> Note: Binary Ninja support is currently on hold while the basic functions are implemented in the Ghidra plugin.
-> This is because plugin development for Binary Ninja is easier as we have Python3. I will resume development soon!
-
-Install the ReVA BinaryNinja plugin by opening your BinaryNinja plugin directory (Plugins -> Open Plugin Folder)
-and copying or symbolic linking the [binary-ninja-assistant](./binary-ninja-assistant) directory into the plugin
-directory.
-
-Restart Binary Ninja and "ReVA Push" will be available in the Plugin menu.
-Press this to push data from BinaryNinja to ReVA, then follow the instructions in the [Workflow section](#workflow).
-The project name will be the name of the current open file.
-
 # Support
 
 Do you like my work? Want to support this project and others? Interested in how this project was designed and built?

{reverse-engineering-assistant-1.0.1 → reverse_engineering_assistant-2.9.1}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "reverse-engineering-assistant"
 readme = "README.md"
-version = "1.0.1"
+version = "2.9.1"
 authors = [
     {name="サイバーカイダ (cyberkaida)"},
 ]
@@ -20,17 +20,15 @@ dependencies = [
     "langchain",
     "langchain-core",
     "langchain-openai",
-    "llama-cpp-python",
     "prompt_toolkit",
     "sentence_transformers",
     "PyYAML",
     "pydantic",
     "rich",
-    "Flask",
+    "grpcio",
+    "protobuf",
 ]
 
 [project.scripts]
-revassistant = "reverse_engineering_assistant.assistant:main"
-reva-serve = "reverse_engineering_assistant.assistant_api_server:main"
 reva-server = "reverse_engineering_assistant.assistant_api_server:main"
-
+reva-chat = "reverse_engineering_assistant.chat_client:main"

reverse_engineering_assistant-2.9.1/reverse_engineering_assistant/.gitignore

@@ -0,0 +1,2 @@
+protocol/
+*_pb2.*

reverse_engineering_assistant-2.9.1/reverse_engineering_assistant/api_server_tools/__init__.py

@@ -0,0 +1,16 @@
+
+
+from typing import List
+
+
+class RevaMessageHandler(object):
+    handles_type = None
+
+
+_global_message_handlers: List[RevaMessageHandler] = []
+
+__all__ = ['register_message_handler']
+
+def register_message_handler(cls: RevaMessageHandler):
+    _global_message_handlers.append(cls)
+    return cls

reverse_engineering_assistant-2.9.1/reverse_engineering_assistant/api_server_tools/connection.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+import sys
+sys.path.append(str(Path(__file__).parent.joinpath('protocol')))
+import grpc
+from grpc import Channel, Server
+
+from typing import Optional
+
+from functools import cache
+
+_channel: Optional[Channel] = None
+@cache
+def get_channel() -> Channel:
+    global _channel
+    if not _channel:
+        raise ValueError("Channel not set")
+    return _channel
+
+@cache
+def connect_to_extension(host: str, port: int) -> Channel:
+    channel: Channel = grpc.insecure_channel(f"{host}:{port}")
+    global _channel
+    _channel = channel
+    return get_channel()

reverse_engineering_assistant-2.9.1/reverse_engineering_assistant/api_server_tools/llm_tools.py

@@ -0,0 +1,111 @@
+
+
+from ast import Call
+import queue
+import threading
+from typing import Callable
+from venv import logger
+
+from ..protocol.RevaChat_pb2_grpc import RevaChatServiceServicer
+from ..protocol.RevaChat_pb2 import RevaChatMessageResponse
+
+from functools import cache
+from ..assistant import ReverseEngineeringAssistant
+
+import logging
+module_logger = logging.getLogger("reva-server")
+
+from langchain_core.callbacks.base import BaseCallbackHandler
+from langchain_core.agents import AgentAction, AgentFinish
+
+class RevaActionCollector(BaseCallbackHandler):
+    """
+    A callback handler for logging agent actions in the reverse engineering assistant.
+
+    This class logs agent actions and calls a callback. This is what prints the green
+    thoughts from the model to the console. This is very useful for the analyst to understand
+    what the model is doing (and is arguably the most important part of the assistant output!)
+
+    Attributes:
+        callback (Callable[[str], None]): The callback function to call when an agent action is performed.
+        logger (logging.Logger): The logger instance for the reverse_engineering_assistant.RevaActionLogger class.
+    """
+
+    callback: Callable[[str], None]
+    def __init__(self, callback: Callable[[str], None]) -> None:
+        super().__init__()
+        self.callback = callback
+
+    logger = logging.getLogger("reverse_engineering_assistant.RevaActionLogger")
+
+    def on_agent_action(self, action: AgentAction, **kwargs) -> None:
+        """
+        Callback method called when an agent action is performed.
+
+        Args:
+            action (AgentAction): The agent action that was performed.
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            None
+        """
+        logger.debug(f"Agent action: {action} {kwargs}")
+        # TODO: Should this be AgentAction?
+        # TODO: Is `.action` still a thing?
+        self.callback(str(action.log))
+
+
+class RevaChat(RevaChatServiceServicer):
+    logger = logging.getLogger("reva-server.RevaChat")
+
+    def chat(self, request, context):
+        self.logger.info(f"Received request: {request}")
+        assistant = ReverseEngineeringAssistant(request.project, langchain_callbacks=[RevaActionCollector(callback)])
+        self.logger.info(f"Assistant: {assistant}")
+        llm_response = assistant.query(request.message)
+        self.logger.info(f"LLM Response: {llm_response}")
+        response = RevaChatMessageResponse()
+        response.message = llm_response
+        return response
+
+    def chatResponseStream(self, request, context):
+        """
+        Given a request, return a stream of responses including
+        thoughts and a final message from the LLM.
+        """
+        self.logger.info(f"Received request: {request}")
+
+        response_queue: queue.Queue = queue.Queue()
+
+        def callback(message: str):
+            # Called for intermediate thoughts
+            response = RevaChatMessageResponse()
+            response.thought = message
+            response_queue.put(response)
+
+        assistant = ReverseEngineeringAssistant(request.project, langchain_callbacks=[RevaActionCollector(callback)])
+        self.logger.info(f"Assistant: {assistant}")
+
+        def run_query(query: str):
+            llm_response = assistant.query(query)
+            self.logger.info(f"LLM Response: {llm_response}")
+            response = RevaChatMessageResponse()
+            response.message = llm_response
+            response_queue.put(response)
+
+        t = threading.Thread(target=run_query, args=[request.message])
+        t.start()
+
+        done = False
+        while not done:
+            response = response_queue.get()
+            # We stop when we get a message and not thoughts
+            if response.message and not response.thought:
+                done = True
+            yield response
+        t.join()
+
+    def chatStream(self, request_iterator, context):
+        # TODO: This needs to be re-written to use the new callback system
+        # let's grab a reference to our assistant
+        raise NotImplementedError("chatStream is not implemented yet")