Package com.goatshriek.rubydragon.ruby

Class RubyGhidraInterpreter

java.lang.Object
com.goatshriek.rubydragon.GhidraInterpreter
com.goatshriek.rubydragon.ScriptableGhidraInterpreter
com.goatshriek.rubydragon.ruby.RubyGhidraInterpreter
All Implemented Interfaces:
ghidra.util.Disposable
public class RubyGhidraInterpreter extends ScriptableGhidraInterpreter
A Ruby interpreter for Ghidra, built using JRuby.

  • Constructor Details

    • RubyGhidraInterpreter

      public RubyGhidraInterpreter()
      Creates a new Ruby interpreter.

    • RubyGhidraInterpreter

      public RubyGhidraInterpreter(ghidra.app.plugin.core.interpreter.InterpreterConsole console, DragonPlugin plugin)
      Creates a new interpreter, and ties the streams for the provided console to the new interpreter.
      Parameters:
      console - The console to bind to the interpreter streams.
      plugin - The plugin that manages this interpreter.

  • Method Details

    • createProxies

      public void createProxies()
      Sets up method proxies at the top level to mirror $script or $current_api methods, as jython does.

    • dispose

      public void dispose()
      Should end the interpreter and release all resources. Currently does nothing.
      Specified by:
      dispose in interface ghidra.util.Disposable
      Specified by:
      dispose in class GhidraInterpreter

    • getCompletions

      public List<ghidra.app.plugin.core.console.CodeCompletion> getCompletions(String cmd)
      Get a list of completions for the given command prefix. Currently not implemented, and will always return an empty list.
      Specified by:
      getCompletions in class GhidraInterpreter
      Parameters:
      cmd - The beginning of a command to try to complete.
      Returns:
      A list of possible code completions.

    • getCurrentAddressName

      public String getCurrentAddressName()
      The name for the current address variable.
      Overrides:
      getCurrentAddressName in class GhidraInterpreter
      Returns:
      The name for the current address variable.
      Since:
      3.1.0

    • getCurrentAPIName

      public String getCurrentAPIName()
      The name for the current FlatProgramAPI variable.
      Overrides:
      getCurrentAPIName in class GhidraInterpreter
      Returns:
      The name for the current API variable.
      Since:
      3.1.0

    • getCurrentDataName

      public String getCurrentDataName()
      The name for the current data variable.
      Overrides:
      getCurrentDataName in class GhidraInterpreter
      Returns:
      The name for the current data variable.
      Since:
      4.0.0

    • getCurrentFunctionName

      public String getCurrentFunctionName()
      The name for the current function variable.
      Overrides:
      getCurrentFunctionName in class GhidraInterpreter
      Returns:
      The name for the current function variable.
      Since:
      4.0.0

    • getCurrentHighlightName

      public String getCurrentHighlightName()
      The name for the current highlight variable.
      Overrides:
      getCurrentHighlightName in class GhidraInterpreter
      Returns:
      The name for the current highlight variable.
      Since:
      3.1.0

    • getCurrentInstructionName

      public String getCurrentInstructionName()
      The name for the current data variable.
      Overrides:
      getCurrentInstructionName in class GhidraInterpreter
      Returns:
      The name for the current data variable.
      Since:
      4.0.0

    • getCurrentLocationName

      public String getCurrentLocationName()
      The name for the current location variable.
      Overrides:
      getCurrentLocationName in class GhidraInterpreter
      Returns:
      The name for the current location variable.
      Since:
      3.1.0

    • getCurrentProgramName

      public String getCurrentProgramName()
      The name for the current program variable.
      Overrides:
      getCurrentProgramName in class GhidraInterpreter
      Returns:
      The name for the current program variable.
      Since:
      3.1.0

    • getCurrentSelectionName

      public String getCurrentSelectionName()
      The name for the current selection variable.
      Overrides:
      getCurrentSelectionName in class GhidraInterpreter
      Returns:
      The name for the current selection variable.
      Since:
      3.1.0

    • getParentPlugin

      public DragonPlugin getParentPlugin()
      The DragonPlugin that this interpreter is attached to.
      Specified by:
      getParentPlugin in class GhidraInterpreter
      Returns:
      The owning plugin of this interpreter.
      Since:
      3.1.0

    • getVersion

      public String getVersion()
      Get the version of Ruby this interpreter supports.
      Specified by:
      getVersion in class GhidraInterpreter
      Returns:
      A string with the version of the interpreter.
      Since:
      3.1.0

    • initInteractiveInterpreter

      public void initInteractiveInterpreter()
      Creates a new Ruby interpreter, sets up the automatic variables, and adds proxies into the namespace for the current Program methods.
      Specified by:
      initInteractiveInterpreter in class GhidraInterpreter
      Since:
      3.1.0

    • importClass

      public void importClass(String packageName, String className)
      Imports a given class into the Ruby environment.
      Specified by:
      importClass in class GhidraInterpreter
      Parameters:
      packageName - The name of the package the class is in.
      className - The name of the class to import.
      Since:
      3.1.0

    • runScript

      public void runScript(ghidra.app.script.GhidraScript script, String[] scriptArguments, ghidra.app.script.GhidraState scriptState) throws IllegalArgumentException, FileNotFoundException, IOException
      Runs the given script with the arguments and state provided. The provided state is loaded into the interpreter at the beginning of execution, and the values of the globals are then exported back into the state after it completes. If the script cannot be found but the script is not running in headless mode, the user will be prompted to ignore the error, which will cause the function to simply continue instead of throwing an IllegalArgumentException.
      Specified by:
      runScript in class ScriptableGhidraInterpreter
      Parameters:
      script - The script to run.
      scriptArguments - The arguments to pass to the script.
      scriptState - The script to load before the script runs, and update after the script finishes.
      Throws:
      IllegalArgumentException - if the script does not exist
      IOException - if the script could not be read
      FileNotFoundException - if the script file wasn't found

    • setErrWriter

      public void setErrWriter(PrintWriter errOut)
      Sets the error output stream for this interpreter.
      Specified by:
      setErrWriter in class GhidraInterpreter
      Parameters:
      errOut - The new error output stream to use for the interpreter.

    • setInput

      public void setInput(InputStream input)
      Sets the input stream for this interpreter.
      Specified by:
      setInput in class GhidraInterpreter
      Parameters:
      input - The new input stream to use for the interpreter.

    • setOutWriter

      public void setOutWriter(PrintWriter output)
      Sets the output stream for this interpreter.
      Specified by:
      setOutWriter in class GhidraInterpreter
      Parameters:
      output - The new output stream to use for the interpreter.

    • setVariable

      public void setVariable(String name, Object value)
      Adds or updates the variable with the given name to the given value in the scripting container.
      Specified by:
      setVariable in class GhidraInterpreter
      Parameters:
      name - The name of the variable to create or update.
      value - The value of the variable to add.

    • startInteractiveSession

      public void startInteractiveSession()
      Starts an interactive session with the current input/output/error streams.
      Specified by:
      startInteractiveSession in class GhidraInterpreter

    • updateProgram

      public void updateProgram(ghidra.program.model.listing.Program program)
      Updates the current program in "$current_program" to the one provided, as well as the "$current_api" variable holding a flat api instance.
      Overrides:
      updateProgram in class GhidraInterpreter
      Parameters:
      program - The new current program.

    • updateState

      public void updateState(ghidra.app.script.GhidraState scriptState)
      Updates a state with the $current_*. variables from the interpreter.
      Specified by:
      updateState in class ScriptableGhidraInterpreter
      Parameters:
      scriptState - The state to update.