Merge pull request #148 from RevEngAI/feat-improvements

feat: branding improvements and easier configuration

Author: robertmarsal

README.md

@@ -100,7 +100,7 @@ You are now ready to analyse a binary.
 Import `src/test/resources/fdupes` into Ghidra and then create a new RevEng analysis, by going to `RevEng.AI -> Analysis -> Create New`.
 Usually it's enough to use the default options, but you can also select specific platforms or architectures if you want to.
 
-![Upload Dialog](screenshots/upload-dialog.png)
+![Upload Dialog](screenshots/upload-dialog-v2.png)
 
 > We are using `fdupes` with symbols to allow the model to learn what these functions look like, and to provide meaningful labels that we can use later to rename similar binaries.
 

screenshots/upload-dialog-v2.png

@@ -1,48 +1,56 @@
 package ai.reveng.toolkit.ghidra.binarysimilarity.ui.analysiscreation;
 
+import ai.reveng.toolkit.ghidra.binarysimilarity.ui.dialog.RevEngDialogComponentProvider;
 import ai.reveng.toolkit.ghidra.core.services.api.AnalysisOptionsBuilder;
 import ai.reveng.toolkit.ghidra.core.services.api.GhidraRevengService;
 import ai.reveng.toolkit.ghidra.core.services.api.types.AnalysisScope;
-import docking.DialogComponentProvider;
+import ai.reveng.toolkit.ghidra.plugins.ReaiPluginPackage;
 import ghidra.program.model.listing.Program;
 
 import javax.annotation.Nullable;
 import javax.swing.*;
 import java.awt.*;
 import java.util.List;
 
-public class RevEngAIAnalysisOptionsDialog extends DialogComponentProvider {
-    private final JCheckBox advancedAnalysisCheckBox;
-    private final JCheckBox dynamicExecutionCheckBox;
+public class RevEngAIAnalysisOptionsDialog extends RevEngDialogComponentProvider {
+    private JCheckBox advancedAnalysisCheckBox;
+    private JCheckBox dynamicExecutionCheckBox;
     private final Program program;
-    private final JRadioButton privateScope;
-    private final JRadioButton publicScope;
-    private final JTextField tagsTextBox;
-    private final JCheckBox scrapeExternalTagsBox;
-    private final JCheckBox identifyCapabilitiesCheckBox;
-    private final JCheckBox identifyCVECheckBox;
-    private final JCheckBox generateSBOMCheckBox;
-    private final JComboBox<String> architectureComboBox;
+    private JRadioButton privateScope;
+    private JRadioButton publicScope;
+    private JTextField tagsTextBox;
+    private JCheckBox scrapeExternalTagsBox;
+    private JCheckBox identifyCapabilitiesCheckBox;
+    private JCheckBox identifyCVECheckBox;
+    private JCheckBox generateSBOMCheckBox;
+    private JComboBox<String> architectureComboBox;
     private boolean okPressed = false;
 
     public static RevEngAIAnalysisOptionsDialog withModelsFromServer(Program program, GhidraRevengService reService) {
         return new RevEngAIAnalysisOptionsDialog(program);
     }
 
     public RevEngAIAnalysisOptionsDialog(Program program) {
-        super("Configure Analysis for %s".formatted(program.getName()), true, false, true, true);
+        super(ReaiPluginPackage.WINDOW_PREFIX + "Configure Analysis for %s".formatted(program.getName()), true);
         this.program = program;
 
+        buildInterface();
+        setPreferredSize(320, 380);
+    }
 
+    private void buildInterface() {
         var workPanel = new JPanel();
         workPanel.setLayout(new BoxLayout(workPanel, BoxLayout.Y_AXIS));
+
         addWorkPanel(workPanel);
 
+        // Create title panel
+        JPanel titlePanel = createTitlePanel("Create new analysis for this binary");
+        workPanel.add(titlePanel, BorderLayout.NORTH);
 
         // Add Platform Drop Down
         var platformComboBox = new JComboBox<>(new String[]{
                 "Auto", "windows", "linux",
-//                "macos", "android"
         });
         platformComboBox.setEditable(false);
         // Center the text
@@ -53,8 +61,6 @@ public RevEngAIAnalysisOptionsDialog(Program program) {
         workPanel.add(platformLabel);
         workPanel.add(platformComboBox);
 
-
-
         // Add Drop down for AnalysisScope
         // Currently just public and private, but in the future this will include teams
         var scopePanel = new JPanel();
@@ -94,7 +100,6 @@ public RevEngAIAnalysisOptionsDialog(Program program) {
 
         // Add Two Check boxes for Dynamic Execution and Advanced Analysis next to each other (horizantally)
         var checkBoxPanel = new JPanel();
-//        checkBoxPanel.setLayout(new BoxLayout(checkBoxPanel, BoxLayout.X_AXIS));
         checkBoxPanel.setLayout(new GridLayout(0, 2));
         dynamicExecutionCheckBox = new JCheckBox("Dynamic Execution");
         dynamicExecutionCheckBox.setToolTipText("Include Dynamic Execution inside a Sandbox Environment with the Analysis");

screenshots/upload-dialog.png

@@ -1,17 +1,18 @@
 package ai.reveng.toolkit.ghidra.binarysimilarity.ui.recentanalyses;
 
+import ai.reveng.toolkit.ghidra.binarysimilarity.ui.dialog.RevEngDialogComponentProvider;
 import ai.reveng.toolkit.ghidra.core.RevEngAIAnalysisStatusChangedEvent;
 import ai.reveng.toolkit.ghidra.core.services.api.GhidraRevengService;
 import ai.reveng.toolkit.ghidra.core.services.api.types.LegacyAnalysisResult;
 import ai.reveng.toolkit.ghidra.core.services.api.types.BinaryHash;
 import ai.reveng.toolkit.ghidra.core.types.ProgramWithBinaryID;
-import docking.DialogComponentProvider;
+import ai.reveng.toolkit.ghidra.plugins.ReaiPluginPackage;
 import ghidra.framework.plugintool.PluginTool;
 import ghidra.program.model.listing.Program;
-import ghidra.util.Msg;
 import ghidra.util.table.GhidraFilterTable;
 
 import javax.swing.*;
+import java.awt.*;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 import java.util.Comparator;
@@ -21,22 +22,35 @@
  * Shows a dialog with a table of {@link LegacyAnalysisResult} for a given {@link BinaryHash},
  * and fires an event when the user picks an analysis
  */
-public class RecentAnalysisDialog extends DialogComponentProvider {
+public class RecentAnalysisDialog extends RevEngDialogComponentProvider {
     private final RecentAnalysesTableModel recentAnalysesTableModel;
     private final GhidraFilterTable<LegacyAnalysisResult> recentAnalysesTable;
     private final PluginTool tool;
     private final Program program;
     private final GhidraRevengService ghidraRevengService;
 
     public RecentAnalysisDialog(PluginTool tool, Program program) {
-        super("Recent Analyses", true);
+        super(ReaiPluginPackage.WINDOW_PREFIX + "Recent Analyses", true);
         this.tool = tool;
         this.program = program;
         this.ghidraRevengService = tool.getService(GhidraRevengService.class);
+
         var hash = new BinaryHash(program.getExecutableSHA256());
         recentAnalysesTableModel = new RecentAnalysesTableModel(tool, hash, this.program.getImageBase());
         recentAnalysesTable = new GhidraFilterTable<>(recentAnalysesTableModel);
 
+        buildInterface();
+        setPreferredSize(600, 400);
+    }
+
+    private void buildInterface() {
+        JPanel mainPanel = new JPanel(new BorderLayout());
+
+        // Create title panel
+        JPanel titlePanel = createTitlePanel("Find existing analyses for this binary");
+        mainPanel.add(titlePanel, BorderLayout.NORTH);
+
+        // Create the table content
         // Add mouse listener to handle clicks on the Analysis ID column
         recentAnalysesTable.getTable().addMouseListener(new MouseAdapter() {
             @Override
@@ -58,6 +72,7 @@ public void mouseClicked(MouseEvent e) {
                 }
             }
         });
+        mainPanel.add(recentAnalysesTable, BorderLayout.CENTER);
 
         JButton pickMostRecentButton = new JButton("Pick most recent");
         pickMostRecentButton.setName("Pick most recent");
@@ -77,8 +92,7 @@ public void mouseClicked(MouseEvent e) {
         });
         addButton(pickSelectedButton);
 
-        rootPanel.add(recentAnalysesTable);
-
+        addWorkPanel(mainPanel);
     }
 
     private void pickAnalysis(LegacyAnalysisResult result) {

src/main/java/ai/reveng/toolkit/ghidra/binarysimilarity/ui/analysiscreation/RevEngAIAnalysisOptionsDialog.java

@@ -15,6 +15,8 @@
 import java.awt.GridBagLayout;
 import java.awt.GridBagConstraints;
 import java.awt.Insets;
+import java.awt.Desktop;
+import java.net.URI;
 import javax.swing.event.DocumentEvent;
 import javax.swing.event.DocumentListener;
 
@@ -109,14 +111,49 @@ public void changedUpdate(DocumentEvent e) {
 		tfPortalHostname.setText("https://portal.reveng.ai");
 		userDetailsPanel.add(tfPortalHostname, gbc);
 
-		// Validate button row
+		// Retrieve API Key link row (above validate button)
 		gbc.gridx = 0;
 		gbc.gridy = 3;
 		gbc.gridwidth = 2;
 		gbc.fill = GridBagConstraints.NONE;
 		gbc.weightx = 0.0;
 		gbc.anchor = GridBagConstraints.CENTER;
-		gbc.insets = new Insets(15, 5, 5, 5);
+		gbc.insets = new Insets(10, 5, 5, 5);
+		JLabel retrieveApiKeyLink = new JLabel("<html><a href=''>Retrieve API Key</a></html>");
+		retrieveApiKeyLink.setCursor(new java.awt.Cursor(java.awt.Cursor.HAND_CURSOR));
+		retrieveApiKeyLink.addMouseListener(new java.awt.event.MouseAdapter() {
+			@Override
+			public void mouseClicked(java.awt.event.MouseEvent e) {
+				try {
+					String portalHostname = tfPortalHostname.getText().trim();
+					if (portalHostname.isEmpty()) {
+						portalHostname = "https://portal.reveng.ai";
+					}
+					// Remove trailing slash if present
+					if (portalHostname.endsWith("/")) {
+						portalHostname = portalHostname.substring(0, portalHostname.length() - 1);
+					}
+					String settingsUrl = portalHostname + "/settings";
+					if (Desktop.isDesktopSupported() && Desktop.getDesktop().isSupported(Desktop.Action.BROWSE)) {
+						Desktop.getDesktop().browse(new URI(settingsUrl));
+					}
+				} catch (Exception ex) {
+					if (loggingService != null) {
+						loggingService.error("Failed to open API key link: " + ex.getMessage());
+					}
+				}
+			}
+		});
+		userDetailsPanel.add(retrieveApiKeyLink, gbc);
+
+		// Validate button row
+		gbc.gridx = 0;
+		gbc.gridy = 4;
+		gbc.gridwidth = 2;
+		gbc.fill = GridBagConstraints.NONE;
+		gbc.weightx = 0.0;
+		gbc.anchor = GridBagConstraints.CENTER;
+		gbc.insets = new Insets(5, 5, 0, 5);
 		JButton runTestsButton = new JButton("Validate Credentials");
 		runTestsButton.addActionListener(e -> {
 			var apiInfo = new ApiInfo(tfApiHostname.getText(), tfPortalHostname.getText(), tfApiKey.getText());
@@ -156,17 +193,14 @@ public void enterPanel(WizardState<SetupWizardStateKey> state) throws IllegalPan
 		Boolean existingValidationState = (Boolean) state.get(SetupWizardStateKey.CREDENTIALS_VALIDATED);
 
 		if (existingApiKey != null && !existingApiKey.isEmpty()) {
-            loggingService.info("Pre-filling API key from existing state");
 			tfApiKey.setText(existingApiKey);
 		}
 
 		if (existingHostname != null && !existingHostname.isEmpty()) {
-            loggingService.info("Pre-filling API hostname from existing state");
 			tfApiHostname.setText(existingHostname);
 		}
 
 		if (existingPortalHostname != null && !existingPortalHostname.isEmpty()) {
-            loggingService.info("Pre-filling Portal hostname from existing state");
 			tfPortalHostname.setText(existingPortalHostname);
 		}
 
@@ -175,7 +209,6 @@ public void enterPanel(WizardState<SetupWizardStateKey> state) throws IllegalPan
 		    existingApiKey != null && !existingApiKey.isEmpty() &&
 		    existingHostname != null && !existingHostname.isEmpty()) {
 			credentialsValidated = true;
-			loggingService.info("Restored credentials validation state from previous session");
 			notifyListenersOfValidityChanged();
 		}
 	}
@@ -198,10 +231,6 @@ public void updateStateObjectWithPanelInfo(WizardState<SetupWizardStateKey> stat
 		state.put(SetupWizardStateKey.HOSTNAME, tfApiHostname.getText());
 		state.put(SetupWizardStateKey.PORTAL_HOSTNAME, tfPortalHostname.getText());
 		state.put(SetupWizardStateKey.CREDENTIALS_VALIDATED, credentialsValidated);
-
-        if (loggingService != null) {
-            loggingService.info("Saved form data and validation state to state");
-        }
 	}
 
 	@Override