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

{reverse-engineering-assistant-1.0.1 → reverse-engineering-assistant-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: reverse-engineering-assistant
-Version: 1.0.1
+Version: 1.0.3
 Summary: An AI assistant for reverse engineering tasks
 Author: サイバーカイダ (cyberkaida)
 Classifier: License :: OSI Approved :: Apache Software License
@@ -145,6 +145,8 @@ revassistant --project ${NAME_OF_YOUR_PROJECT}
 
 ## Usage
 
+The [ghidra-assistant](ghidra-assistant/README.md) plugin must be installed first. 
+
 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.

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

@@ -124,6 +124,8 @@ revassistant --project ${NAME_OF_YOUR_PROJECT}
 
 ## Usage
 
+The [ghidra-assistant](ghidra-assistant/README.md) plugin must be installed first. 
+
 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.

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

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "reverse-engineering-assistant"
 readme = "README.md"
-version = "1.0.1"
+version = "1.0.3"
 authors = [
     {name="サイバーカイダ (cyberkaida)"},
 ]

{reverse-engineering-assistant-1.0.1 → reverse-engineering-assistant-1.0.3}/reverse_engineering_assistant/api_server_tools/llm_tools.py

@@ -1,9 +1,18 @@
 from typing import Dict, List, Optional
 from ..assistant_api_server import register_message_handler, RevaMessageHandler, RevaCallbackHandler
-from ..tool_protocol import RevaGetNewVariableName, RevaGetNewVariableNameResponse, RevaGetNewSymbolName, RevaGetNewSymbolNameResponse
+from ..tool_protocol import (
+    RevaExplain,
+    RevaGetNewVariableName,
+    RevaGetNewVariableNameResponse,
+    RevaGetNewSymbolName,
+    RevaGetNewSymbolNameResponse,
+    RevaExplain,
+    RevaExplainResponse,
+    RevaLocation,
+)
 
 from ..reva_exceptions import RevaToolException
-
+import threading
 import logging
 
 
@@ -36,4 +45,23 @@ class HandleGetNewSymbolName(RevaMessageHandler):
         # Block until ReVa finishes analysis.
         _ = self.assistant.query(question)
         response = RevaGetNewSymbolNameResponse(response_to=message.message_id)
-        return response
+        return response
+
+@register_message_handler
+class HandleExplain(RevaMessageHandler):
+    handles_type = RevaExplain
+    def run(self, callback_handler: RevaCallbackHandler) -> RevaExplainResponse:
+        # Extract the content and ask the LLM what it thinks...
+        assert isinstance(callback_handler.message, RevaExplain)
+        message: RevaExplain = callback_handler.message
+        question = f"""
+        Explain the following location in detail, leave comments as needed.
+        """
+
+        location: RevaLocation = message.location
+
+        if message.location is not None:
+            question += f"\n{message.location}"
+        # Block until ReVa finishes analysis.
+        threading.Thread(target=self.assistant.query, args=(question,)).start()
+        return RevaExplainResponse(response_to=message.message_id)

reverse-engineering-assistant-1.0.1/reverse_engineering_assistant/api_server_tools/function_tools.py → reverse-engineering-assistant-1.0.3/reverse_engineering_assistant/api_server_tools/re_tools.py

@@ -91,13 +91,14 @@ class RevaDecompilationIndex(RevaRemoteTool):
         # Now we can ask the tool
         get_decompilation_message = RevaGetDecompilation(address=address, function=name)
         response = self.submit_to_tool(get_decompilation_message)
-        assert isinstance(response, RevaMessageResponse), "Incorrect type returned from callback handler."
-
         if response.error_message:
             raise RevaToolException(response.error_message)
+        assert isinstance(response, RevaMessageResponse), "Incorrect type returned from callback handler."
+
+
 
         if not isinstance(response, RevaGetDecompilationResponse):
-            raise ValueError(f"Expected a RevaGetDecompilationResponse, got {response}")
+            raise RevaToolException(f"Expected a RevaGetDecompilationResponse, got {response}")
 
         respose: RevaGetDecompilationResponse = response
 
@@ -107,6 +108,7 @@ class RevaDecompilationIndex(RevaRemoteTool):
             "function_signature": response.function_signature,
             "address": hex(response.address),
             "decompilation": response.decompilation,
+            "listing": response.listing,
             "variables": response.variables, #type: ignore # We can ignore this because it can be serialised to a dict
         }
 
@@ -226,7 +228,10 @@ class RevaCrossReferenceTool(RevaRemoteTool):
         These might be calls from/to other functions, or data references from/to this address.
         """
         from ..tool_protocol import RevaGetReferences, RevaGetReferencesResponse
-
+        if isinstance(address_or_symbol, int):
+            address_or_symbol = hex(address_or_symbol)
+        if not isinstance(address_or_symbol, str):
+            raise RevaToolException(f"address_or_symbol must be a string. Provided type was {type(address_or_symbol)}")
         get_references_message = RevaGetReferences(address_or_symbol=address_or_symbol)
         response = self.submit_to_tool(get_references_message)
         assert isinstance(response, RevaMessageResponse), "Incorrect type returned from callback handler."
@@ -274,4 +279,33 @@ class RevaSetSymbolName(RevaRemoteTool):
         return {
             "old_name": old_name_or_address,
             "new_name": new_name,
-        }
+        }
+
+@register_tool
+class RevaSetComment(RevaRemoteTool):
+    """
+    A tool for setting comments on addresses, functions and symbols.
+    """
+
+    def __init__(self, project: AssistantProject, llm: BaseLLM) -> None:
+        super().__init__(project, llm)
+        self.description = "Used for setting comments on addresses, functions and symbols"
+
+        self.tool_functions = [
+            self.set_comment,
+        ]
+
+    def set_comment(self, comment: str, address_or_symbol: str) -> Dict[str, str]:
+        """
+        Set the comment at the given address, function or symbol to `comment`.
+        Use this when you want to add an explanation or note to a specific part
+        of the code.
+        """
+        from ..tool_protocol import RevaSetComment, RevaSetCommentResponse
+        set_comment_message: RevaMessageToTool = RevaSetComment(comment=comment, address_or_symbol=address_or_symbol)
+
+        response = self.submit_to_tool(set_comment_message)
+        assert isinstance(response, RevaSetCommentResponse), f"Expected a RevaSetCommentResponse, got {response}"
+        response: RevaSetCommentResponse = response
+
+        return response.model_dump()

{reverse-engineering-assistant-1.0.1 → reverse-engineering-assistant-1.0.3}/reverse_engineering_assistant/assistant_api_server.py

@@ -281,7 +281,7 @@ def run_task(project_name: str):
 
     reva_message = RevaMessage.to_specific_message(message) # type: ignore
     assert isinstance(reva_message, RevaMessageToReva)
-    reva_message: RevaMessageToReva = reva_message
+    reva_message: RevaMessageToReva = reva_message # type: ignore
 
     logger.debug(f"Processing message {reva_message}")
 
@@ -338,7 +338,7 @@ def run_server(port: int = REVA_PORT) -> None:
     logging.getLogger("werkzeug").setLevel(logging.WARNING)
     # Import these down here to avoid a circular import
     # We need to have all the handlers registered before we start
-    from .api_server_tools import function_tools, llm_tools
+    from .api_server_tools import re_tools, llm_tools
     app.run(host='localhost', port=port, debug=False)
 
 def main():

{reverse-engineering-assistant-1.0.1 → reverse-engineering-assistant-1.0.3}/reverse_engineering_assistant/tool_protocol.py

@@ -33,8 +33,10 @@ import json
 from pathlib import Path
 import logging
 
+from click import Option
 from pydantic import BaseModel, Field
 import pydantic
+import pydantic_core
 
 try:
     from pydantic import validator
@@ -99,9 +101,11 @@ class RevaMessage(BaseModel, ABC):
             logger.debug(f"Message class is {message_class}")
             try:
                 return message_class.model_validate(thing)
-            except pydantic.error_wrappers.ValidationError:
+            except pydantic_core.ValidationError:
+                # If we fail to turn it into a specific type, make it a generic type
+                # This allows us to extract things like error messages.
                 if issubclass(message_class, RevaMessageResponse):
-                    return RevaMessageResponse.parse_obj(thing)
+                    return RevaMessageResponse.model_validate(thing)
                 else:
                     logger.exception(f"Failed to parse {thing} as {message_class}")
                 return RevaMessage.model_validate(thing)
@@ -246,9 +250,9 @@ class RevaGetDecompilation(RevaMessageToTool):
 
 class RevaVariable(BaseModel):
     name: str = Field()
-    storage: Optional[str] = Field()
-    data_type: Optional[str] = Field()
-    size: Optional[int] = Field()
+    storage: Optional[str] = Field(default=None)
+    data_type: Optional[str] = Field(default=None)
+    size: Optional[int] = Field(default=None)
 
 @register_message
 class RevaGetDecompilationResponse(RevaMessageToReva, RevaMessageResponse):
@@ -264,6 +268,10 @@ class RevaGetDecompilationResponse(RevaMessageToReva, RevaMessageResponse):
     """
     The decompilation of the given address
     """
+    listing: Optional[str] = Field(default=None)
+    """
+    The disassebly listing of the function
+    """
     function: str = Field()
     """
     The function this decompilation is for
@@ -457,4 +465,45 @@ class RevaRenameVariableResponse(RevaMessageToReva, RevaMessageResponse):
 
     A simple yes/no, not much to respond with.
     """
-    message_type: str = "RevaRenameVariableResponse"
+    message_type: str = "RevaRenameVariableResponse"
+
+class RevaLocation(BaseModel):
+    cursor_address: Optional[str] = Field(default=None)
+    function_name: Optional[str] = Field(default=None)
+    start_address: Optional[str] = Field(default=None)
+    end_address: Optional[str] = Field(default=None)
+    content: Optional[str] = Field(default=None)
+
+@register_message
+class RevaExplain(RevaMessageToReva):
+    """
+    Ask the model to explain something
+    """
+    message_type: str = "RevaExplain"
+    location: RevaLocation = Field()
+    """
+    The location to explain
+    """
+
+@register_message
+class RevaExplainResponse(RevaMessageToTool, RevaMessageResponse):
+    """
+    Response to a RevaExplain message
+    """
+    message_type: str = "RevaExplainResponse"
+
+@register_message
+class RevaSetComment(RevaMessageToTool):
+    """
+    Set a comment at a given address
+    """
+    message_type: str = "RevaSetComment"
+    address_or_symbol: str = Field()
+    comment: str = Field()
+
+@register_message
+class RevaSetCommentResponse(RevaMessageToReva, RevaMessageResponse):
+    """
+    Response to a RevaSetComment message
+    """
+    message_type: str = "RevaSetCommentResponse"

{reverse-engineering-assistant-1.0.1 → reverse-engineering-assistant-1.0.3}/reverse_engineering_assistant.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: reverse-engineering-assistant
-Version: 1.0.1
+Version: 1.0.3
 Summary: An AI assistant for reverse engineering tasks
 Author: サイバーカイダ (cyberkaida)
 Classifier: License :: OSI Approved :: Apache Software License
@@ -145,6 +145,8 @@ revassistant --project ${NAME_OF_YOUR_PROJECT}
 
 ## Usage
 
+The [ghidra-assistant](ghidra-assistant/README.md) plugin must be installed first. 
+
 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.

{reverse-engineering-assistant-1.0.1 → reverse-engineering-assistant-1.0.3}/reverse_engineering_assistant.egg-info/SOURCES.txt

@@ -16,5 +16,5 @@ reverse_engineering_assistant.egg-info/entry_points.txt
 reverse_engineering_assistant.egg-info/requires.txt
 reverse_engineering_assistant.egg-info/top_level.txt
 reverse_engineering_assistant/api_server_tools/__init__.py
-reverse_engineering_assistant/api_server_tools/function_tools.py
-reverse_engineering_assistant/api_server_tools/llm_tools.py
+reverse_engineering_assistant/api_server_tools/llm_tools.py
+reverse_engineering_assistant/api_server_tools/re_tools.py