feat: setting up for v1.0

Author: anisiosts

README.md

@@ -125,9 +125,9 @@ Use function matching to identify similar functions in other binaries or collect
 
 - Click `RevEng.AI > Match Functions`
 
-> 🖼️ *Insert screenshot of match functions result*
+<img src="./images/matchedfunctions.png" >
 
-Matched functions are displayed with similarity and metadata. You can navigate or rename based on the results.
+Matched functions are displayed based on the given confidence value. You can navigate or rename based on the results.
 
 ---
 

images/matchedfunctions.png

@@ -3,5 +3,6 @@
 from .auto_unstrip import AutoUnstripFeature
 from .choose_source import ChooseSourceFeature
 from .match_functions import MatchFunctionsFeature
+from .match_current_function import MatchCurrentFunctionFeature
 
-__all__ = ['ConfigurationFeature', 'UploadFeature', 'AutoUnstripFeature', 'ChooseSourceFeature', 'MatchFunctionsFeature'] 
+__all__ = ['ConfigurationFeature', 'UploadFeature', 'AutoUnstripFeature', 'ChooseSourceFeature', 'MatchFunctionsFeature', 'MatchCurrentFunctionFeature'] 

revengai/features/__init__.py

@@ -11,7 +11,7 @@ def __init__(self, config=None):
 
     def register(self):
         PluginCommand.register(
-            "RevEng.AI\\Auto Unstrip",
+            "RevEng.AI\\4 - Auto Unstrip",
             "Attempt to recover stripped function names",
             self.show_auto_unstrip_dialog,
             self.is_valid

revengai/features/auto_unstrip/__init__.py

@@ -3,6 +3,7 @@
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from typing import List, Dict, Tuple
 import math
+from revengai.utils import rename_function as rename_function_util
 
 class AutoUnstrip:
     def __init__(self, config):
@@ -12,29 +13,7 @@ def __init__(self, config):
         self.path = None
         self.max_workers = 4 
 
-    def _rename_function(self, bv: BinaryView, addr: int, new_name: str, new_name_mangled: str) -> bool:
-        try:
-            func = bv.get_function_at(addr)
-            if not func:
-                log_error(f"RevEng.AI | No function found at address {hex(addr)}")
-                return False
-            
-            if func.name == new_name or func.name == new_name_mangled:
-                log_info(f"RevEng.AI | Function at {hex(addr)} already has name {func.name}")
-                return False
-            
-            new_symbol = Symbol(SymbolType.FunctionSymbol, addr, new_name)
-            bv.define_user_symbol(new_symbol)
-            
-            log_info(f"RevEng.AI | Renamed function at {hex(addr)} to {new_name}")
-            return True
-
-        except Exception as e:
-            log_error(f"RevEng.AI | Error renaming function at {hex(addr)}: {str(e)}")
-            return False
-
     def _process_batch(self, function_ids: List[int], id_to_addr: Dict[int, int], bv: BinaryView) -> Tuple[int, List[str]]:
-        """Process a batch of function IDs and return the number of renamed functions"""
         try:
             functions_by_distance = RE_nearest_symbols_batch(
                 function_ids=function_ids,
@@ -69,16 +48,17 @@ def _process_batch(self, function_ids: List[int], id_to_addr: Dict[int, int], bv
                     for function in functions_by_score:
                         if function['function_id'] == func_id:
                            if function['box_plot']["average"] < 0.9:
-                                log_info(f"RevEng.AI | Function {function['function_id']} has a score of {function['box_plot']['average']:.2f} for name {function['function_name']}, skipping")
+                                log_info(f"RevEng.AI | Function {function['function_id']} has a score of {function['box_plot']['average']:.2f} for name {new_name_mangled}, skipping")
                                 break
                            else:
-                                log_info(f"RevEng.AI | Function {function['function_id']} has a score of {function['box_plot']['average']:.2f} for name {function['function_name']}, renaming")
-                                if self._rename_function(bv, func_addr, new_name, new_name_mangled):
+                                log_info(f"RevEng.AI | Function {function['function_id']} has a score of {function['box_plot']['average']:.2f} for name {new_name_mangled}, renaming")
+                                if rename_function_util(bv, func_addr, new_name_mangled):
                                     renamed_count += 1
                                 break
 
 
                 except Exception as e:
+                    log_error(f"RevEng.AI | Error processing function {result['origin_function_id']}: {str(e)}")
                     errors.append(str(e))
 
             return renamed_count, errors

revengai/features/auto_unstrip/auto_unstrip.py

@@ -1,14 +1,12 @@
-from binaryninja import BinaryView, PluginCommand, log_info, log_error
+from binaryninja import log_error
 from PySide6.QtWidgets import (QDialog, QVBoxLayout, QHBoxLayout, 
-                             QPushButton, QLabel, QCheckBox, 
-                             QGroupBox, QRadioButton, QSpacerItem,
-                             QSizePolicy)
+                             QPushButton, QLabel)
 from PySide6.QtCore import Qt
-from PySide6.QtGui import QPixmap, QIcon
+from PySide6.QtGui import QPixmap
 from PySide6.QtCore import QCoreApplication
 from PySide6.QtWidgets import QMessageBox
 from revengai.utils import create_progress_dialog
-from .auto_unstrip_thread import AutoUnstripThread
+from revengai.utils.data_thread import DataThread
 import os
 
 class AutoUnstripDialog(QDialog):
@@ -38,9 +36,7 @@ def init_ui(self):
         info_layout = QVBoxLayout()
         title_label = QLabel("Auto Unstrip Binary")
         title_label.setStyleSheet("font-size: 18px; font-weight: bold;")
-        description_label = QLabel(
-            "Using official RevEng.AI sources, function names will be recovered based on a high similarity and confidence threshold and limited to available debug symbols.\nFunctions will be renamed automatically for easier analysis.\n\nThis process may take several minutes depending on the binary size."
-        )
+        description_label = QLabel("Using official RevEng.AI sources, function names will be recovered based on a high similarity and confidence threshold and limited to available debug symbols.\nFunctions will be renamed automatically for easier analysis.\n\nThis process may take several minutes depending on the binary size.")
         description_label.setWordWrap(True)
         info_layout.addWidget(title_label)
         info_layout.addWidget(description_label)
@@ -49,7 +45,6 @@ def init_ui(self):
         layout.addLayout(header_layout)
         layout.addSpacing(20)
 
-        # Buttons
         button_layout = QHBoxLayout()
         self.save_button = QPushButton("Auto Unstrip")
         self.save_button.setStyleSheet("""
@@ -76,40 +71,24 @@ def init_ui(self):
         button_layout.addWidget(self.save_button)
         button_layout.addWidget(self.cancel_button)
         layout.addLayout(button_layout)
-
         self.setLayout(layout)
 
     def _auto_unstrip(self):
-        log_info("RevEng.AI | Auto Unstripping binary")
-        # Create and show progress dialog using utility function
         self.progress = create_progress_dialog(self, "RevEng.AI Auto Unstrip", "Auto Unstripping binary...")
+        self.progress.show()
+        QCoreApplication.processEvents()   
 
-        # Create and start upload thread
-        self.auto_unstrip_thread = AutoUnstripThread(self.auto_unstrip, self.bv)
+        self.auto_unstrip_thread = DataThread(self.auto_unstrip.auto_unstrip, self.bv)
         self.auto_unstrip_thread.finished.connect(self._on_auto_unstrip_finished)
         self.auto_unstrip_thread.start()
-        
-        self.progress.show()
-        QCoreApplication.processEvents()    
-        
 
     def _on_auto_unstrip_finished(self, success, message):
-        """Handle auto unstrip completion"""
         self.progress.close()
 
         if success:
-            QMessageBox.information(
-                self,
-                "RevEng.AI Auto Unstrip",
-                f"Binary auto unstripped successfully!\n{message}",
-                QMessageBox.Ok
-            )
+            QMessageBox.information(self, "RevEng.AI Auto Unstrip", f"Binary auto unstripped successfully!\n{message}", QMessageBox.Ok)
             self.accept()
         else:
             log_error(f"RevEng.AI | Failed to auto unstrip binary: {message}")
-            QMessageBox.critical(
-                self,
-                "RevEng.AI Auto Unstrip Error",
-                f"Failed to auto unstrip binary: {message}",
-                QMessageBox.Ok
-            ) 
+            QMessageBox.critical(self, "RevEng.AI Auto Unstrip Error", f"Failed to auto unstrip binary: {message}", QMessageBox.Ok)
+            self.reject()

revengai/features/auto_unstrip/auto_unstrip_dialog.py

@@ -11,7 +11,7 @@ def __init__(self, config=None):
 
     def register(self):
         PluginCommand.register(
-            "RevEng.AI\\Choose Source",
+            "RevEng.AI\\3 - Choose Source",
             "Choose a source for the binary analysis",
             self.show_choose_source_dialog,
             self.is_valid

revengai/features/auto_unstrip/auto_unstrip_thread.py

@@ -1,8 +1,5 @@
-from binaryninja import BinaryView, log_info, log_error, Symbol, SymbolType
-from reait.api import RE_authentication, RE_search, RE_nearest_symbols_batch, RE_analyze_functions
-from concurrent.futures import ThreadPoolExecutor, as_completed
-from typing import List, Dict, Tuple
-import math
+from binaryninja import BinaryView, log_info, log_error
+from reait.api import RE_search
 
 class ChooseSource:
     def __init__(self, config):
@@ -15,15 +12,15 @@ def choose_source(self, bv: BinaryView, chose: str):
             binary_id = self.config.get_binary_id(bv)
             if binary_id == new_binary_id:
                 log_info("RevEng.AI | Binary ID is already set to the chosen one.")
-                return True
+                return True, "Binary ID is already set to the chosen one."
 
             log_info(f"RevEng.AI | Changing Binary ID: {binary_id} to {new_binary_id}")
             self.config.set_current_info(new_binary_id)
 
-            return True
+            return True, "Binary ID changed successfully."
         except Exception as e:
             log_error(f"RevEng.AI | Failed to choose source: {str(e)}")
-            return False
+            return False, str(e)
 
     def get_analysis(self, bv: BinaryView):
         try:
@@ -46,7 +43,7 @@ def get_analysis(self, bv: BinaryView):
                 else:
                     options.append(option)
 
-            return options
+            return True, options
         except Exception as e:
             log_error(f"RevEng.AI | Failed to get analysis: {str(e)}")
-            return []
+            return False, str(e)