Added processor check to MIPS only scripts before running them.

Author: fuzzywalls

LeafBlowerFormatString.py

@@ -1,4 +1,4 @@
-# Identify potential POSIX functions in the current program such as
+# Identify potential POSIX functions in the current program such as sprintf, fprintf, sscanf, etc.
 #@author fuzzywalls
 #@category TNS
 #@menupath TNS.Leaf Blower.Find format string functions

MipsRopDouble.py

@@ -4,7 +4,9 @@
 #@menupath TNS.Mips Rops.Double Jumps
 
 
-from utils import mipsrop
+from utils import mipsrop, utils
+
+utils.allowed_processors(currentProgram, 'MIPS')
 
 mips_rop = mipsrop.MipsRop(currentProgram)
 doubles = mips_rop.find_doubles()

MipsRopFind.py

@@ -5,7 +5,9 @@
 
 
 import re
-from utils import mipsrop
+from utils import mipsrop, utils
+
+utils.allowed_processors(currentProgram, 'MIPS')
 
 op1 = None
 op2 = None

MipsRopIret.py

@@ -4,7 +4,9 @@
 #@menupath TNS.Mips Rops.Indirect Return
 
 
-from utils import mipsrop
+from utils import mipsrop, utils
+
+utils.allowed_processors(currentProgram, 'MIPS')
 
 move_t9 = mipsrop.MipsInstruction('.*move', 't9', '[sav][012345678]')
 

MipsRopLia0.py

@@ -4,7 +4,9 @@
 #@menupath TNS.Mips Rops.Li a0
 
 
-from utils import mipsrop
+from utils import mipsrop, utils
+
+utils.allowed_processors(currentProgram, 'MIPS')
 
 li_a0 = mipsrop.MipsInstruction('.*li', 'a0', '0x.*')
 

MipsRopStackFinder.py

@@ -4,7 +4,9 @@
 #@menupath TNS.Mips Rops.Stack Finder
 
 
-from utils import mipsrop
+from utils import mipsrop, utils
+
+utils.allowed_processors(currentProgram, 'MIPS')
 
 sf_saved_reg = mipsrop.MipsInstruction('.*addiu', '[sva][012345678]', 'sp')
 

MipsRopSummary.py

@@ -4,8 +4,9 @@
 #@menupath TNS.Mips Rops.Summary
 
 
-from utils import mipsrop
+from utils import mipsrop, utils
 
+utils.allowed_processors(currentProgram, 'MIPS')
 
 mips_rop = mipsrop.MipsRop(currentProgram)
 mips_rop.summary()

MipsRopSystem.py

@@ -4,7 +4,9 @@
 #@menupath TNS.Mips Rops.System Calls
 
 
-from utils import mipsrop
+from utils import mipsrop, utils
+
+utils.allowed_processors(currentProgram, 'MIPS')
 
 set_a0 = mipsrop.MipsInstruction('.*addiu', 'a0', 'sp')
 

RenameVariables.py

@@ -4,8 +4,12 @@
 #@keybinding
 #@menupath TNS.Rename Variables
 
+from utils import utils
 from ghidra.program.model.symbol import SourceType
 
+
+utils.allowed_processors(currentProgram, 'MIPS')
+
 func_man = currentProgram.getFunctionManager()
 code_man = currentProgram.getCodeManager()
 

utils/utils.py

@@ -53,6 +53,15 @@ def get_processor(current_program):
 
 
 def find_function(current_program, function_name):
+    """
+    Find a function, by name, in the current program.
+
+    :param current_program: Current program loaded in Ghidra.
+    :type current_program: ghidra.program.model.listing.Program
+
+    :param function_name: Function to search for.
+    :type function_name: str
+    """
     listing = current_program.getListing()
     if listing:
         return listing.getGlobalFunctions(function_name)
@@ -70,3 +79,21 @@ def address_to_int(address):
     :rtype: int
     """
     return int(address.toString(), 16)
+
+
+def allowed_processors(current_program, processor_list):
+    """
+    Function to prevent scripts from running against unsupported processors.
+
+    :param current_program: Current program loaded in Ghidra.
+    :type current_program: ghidra.program.model.listing.Program
+
+    :param processor_list: List of supported processors.
+    :type processor_list: list(str)
+    """
+    curr_processor = get_processor(current_program)
+
+    if curr_processor not in processor_list:
+        print '%s is not a valid processor for this script. Supported ' \
+            'processors are: %s' % (curr_processor, processor_list)
+        exit(1)