Merge pull request #54 from softwaresecured/feature-51

#51 - Added shared memory feature

Author: fi7z

README.md

@@ -9,6 +9,7 @@ Burp Hotpatch ️provides pentesters with a quick way to hook into key BurpSuite
 - Add custom actions to the context menu for quick execution of other tools.
 - Easily work with the Montoya API within Burp.
 - Task manager to control execution of utility and context menu actions
+- Shared variables between scripts
 
 # Use cases
 - Session handling actions that require further processing after the session macro has run.

resources/templates/javascript/stub/utility.js

@@ -8,6 +8,12 @@
     - You can import Java libraries using the following syntax:
         var Matcher = Packages.java.util.regex.Matcher;
 
+    Memory:
+    - Variables can be shared across scripts using the memory feature
+    - The setString(name,value), setInt(name,value) and setObject(name,value) functions can be used to set values
+    - The getString(name), getInt(name) and getObject(name) functions can be used to retrieve values
+    - The above functions throw the burp_hotpatch.script.ScriptSharedMemoryException exception
+
     Example:
     - This script prints the current BurpSuite version
 

resources/templates/python/stub/utility.py

@@ -8,6 +8,12 @@
     - You can import Java libraries using the following syntax:
         from java.util.regex import Matcher
 
+    Memory:
+    - Variables can be shared across scripts using the memory feature
+    - The setString(name,value), setInt(name,value) and setObject(name,value) functions can be used to set values
+    - The getString(name), getInt(name) and getObject(name) functions can be used to retrieve values
+    - The above functions raise the burp_hotpatch.script.ScriptSharedMemoryException exception
+
     Example:
     - This script prints the current BurpSuite version
 

src/burp/VERSION.java

@@ -3,7 +3,7 @@
 public final class VERSION {
     public static final int VERSION_MAJOR = 1;
     public static final int VERSION_MINOR = 0;
-    public static final int VERSION_PATCH = 12;
+    public static final int VERSION_PATCH = 13;
     public static final String RELEASE_TYPE = "beta";
     public static final String RELEASE_TAGS_URL = "https://github.com/softwaresecured/burp-hotpatch/tags";
 

src/burp_hotpatch/scripts/ScriptExecutionContainer.java

@@ -72,6 +72,7 @@ public Object execute() throws ScriptExecutionException {
                     .allowHostClassLookup(className -> true)
                     .build();
 
+            cx.getBindings(languageId).putMember("memory",ScriptSharedMemory.getInstance());
             cx.getBindings(languageId).putMember("montoyaApi", MontoyaUtil.getInstance().getApi());
             if ( argumentName != null ) {
                 cx.getBindings(languageId).putMember(argumentName, argument);

src/burp_hotpatch/scripts/ScriptSharedMemory.java

@@ -0,0 +1,61 @@
+package burp_hotpatch.scripts;
+import java.util.HashMap;
+
+public class ScriptSharedMemory {
+
+    private HashMap<String,String> strings;
+    private HashMap<String,Integer> integers;
+    private HashMap<String,Object> objects;
+
+    private static ScriptSharedMemory INSTANCE;
+    public ScriptSharedMemory() {
+    }
+
+    public static ScriptSharedMemory getInstance() {
+        if(INSTANCE == null) {
+            INSTANCE = new ScriptSharedMemory();
+            INSTANCE.reset();
+        }
+        return INSTANCE;
+    }
+
+    public void reset() {
+        strings = new HashMap<>();
+        integers = new HashMap<>();
+        objects = new HashMap<>();
+    }
+
+    public synchronized void setInt( String name, int num ) {
+        integers.put(name,num);
+    }
+
+    public int getInt( String name ) throws ScriptSharedMemoryException {
+        if ( integers.get(name) == null ) {
+            throw new ScriptSharedMemoryException(String.format("Key %s does not exist", name));
+        }
+        return integers.get(name);
+    }
+
+    public synchronized void setString( String name, String str ) {
+        strings.put(name,str);
+    }
+
+    public String getString( String name ) throws ScriptSharedMemoryException {
+        if ( objects.get(name) == null ) {
+            throw new ScriptSharedMemoryException(String.format("Key %s does not exist", name));
+        }
+        return strings.get(name);
+    }
+
+    public synchronized void setObject( String name, Object obj ) {
+        objects.put(name,obj);
+    }
+
+    public Object getObject( String name ) throws ScriptSharedMemoryException {
+        if ( objects.get(name) == null ) {
+            throw new ScriptSharedMemoryException(String.format("Key %s does not exist", name));
+        }
+        return objects.get(name);
+    }
+
+}

src/burp_hotpatch/scripts/ScriptSharedMemoryException.java

@@ -0,0 +1,6 @@
+package burp_hotpatch.scripts;
+public class ScriptSharedMemoryException extends Exception {
+    public ScriptSharedMemoryException(String errorMessage) {
+        super(errorMessage);
+    }
+}