Land rapid7#4810, support for job renaming in msfconsole

Author: wvu

features/commands/help.feature

@@ -36,6 +36,7 @@ Feature: Help command
           pushm         Pushes the active or list of modules onto the module stack
           quit          Exit the console
           reload_all    Reloads all modules from all defined module paths
+          rename_job    Rename a job
           resource      Run the commands stored in a file
           route         Route traffic through a session
           save          Saves the active datastores

lib/msf/ui/console/command_dispatcher/core.rb

@@ -107,47 +107,48 @@ class Core
   # Returns the list of commands supported by this command dispatcher
   def commands
     {
-      "?"        => "Help menu",
-      "back"     => "Move back from the current context",
-      "banner"   => "Display an awesome metasploit banner",
-      "cd"       => "Change the current working directory",
-      "connect"  => "Communicate with a host",
-      "color"    => "Toggle color",
-      "exit"     => "Exit the console",
-      "edit"     => "Edit the current module with $VISUAL or $EDITOR",
-      "get"      => "Gets the value of a context-specific variable",
-      "getg"     => "Gets the value of a global variable",
-      "go_pro"   => "Launch Metasploit web GUI",
-      "grep"     => "Grep the output of another command",
-      "help"     => "Help menu",
-      "info"     => "Displays information about one or more module",
-      "irb"      => "Drop into irb scripting mode",
-      "jobs"     => "Displays and manages jobs",
-      "kill"     => "Kill a job",
-      "load"     => "Load a framework plugin",
-      "loadpath" => "Searches for and loads modules from a path",
-      "popm"     => "Pops the latest module off the stack and makes it active",
-      "pushm"    => "Pushes the active or list of modules onto the module stack",
-      "previous" => "Sets the previously loaded module as the current module",
-      "quit"     => "Exit the console",
-      "resource" => "Run the commands stored in a file",
-      "makerc"   => "Save commands entered since start to a file",
+      "?"          => "Help menu",
+      "back"       => "Move back from the current context",
+      "banner"     => "Display an awesome metasploit banner",
+      "cd"         => "Change the current working directory",
+      "connect"    => "Communicate with a host",
+      "color"      => "Toggle color",
+      "exit"       => "Exit the console",
+      "edit"       => "Edit the current module with $VISUAL or $EDITOR",
+      "get"        => "Gets the value of a context-specific variable",
+      "getg"       => "Gets the value of a global variable",
+      "go_pro"     => "Launch Metasploit web GUI",
+      "grep"       => "Grep the output of another command",
+      "help"       => "Help menu",
+      "info"       => "Displays information about one or more module",
+      "irb"        => "Drop into irb scripting mode",
+      "jobs"       => "Displays and manages jobs",
+      "rename_job" => "Rename a job",
+      "kill"       => "Kill a job",
+      "load"       => "Load a framework plugin",
+      "loadpath"   => "Searches for and loads modules from a path",
+      "popm"       => "Pops the latest module off the stack and makes it active",
+      "pushm"      => "Pushes the active or list of modules onto the module stack",
+      "previous"   => "Sets the previously loaded module as the current module",
+      "quit"       => "Exit the console",
+      "resource"   => "Run the commands stored in a file",
+      "makerc"     => "Save commands entered since start to a file",
       "reload_all" => "Reloads all modules from all defined module paths",
-      "route"    => "Route traffic through a session",
-      "save"     => "Saves the active datastores",
-      "search"   => "Searches module names and descriptions",
-      "sessions" => "Dump session listings and display information about sessions",
-      "set"      => "Sets a context-specific variable to a value",
-      "setg"     => "Sets a global variable to a value",
-      "show"     => "Displays modules of a given type, or all modules",
-      "sleep"    => "Do nothing for the specified number of seconds",
-      "threads"  => "View and manipulate background threads",
-      "unload"   => "Unload a framework plugin",
-      "unset"    => "Unsets one or more context-specific variables",
-      "unsetg"   => "Unsets one or more global variables",
-      "use"      => "Selects a module by name",
-      "version"  => "Show the framework and console library version numbers",
-      "spool"    => "Write console output into a file as well the screen"
+      "route"      => "Route traffic through a session",
+      "save"       => "Saves the active datastores",
+      "search"     => "Searches module names and descriptions",
+      "sessions"   => "Dump session listings and display information about sessions",
+      "set"        => "Sets a context-specific variable to a value",
+      "setg"       => "Sets a global variable to a value",
+      "show"       => "Displays modules of a given type, or all modules",
+      "sleep"      => "Do nothing for the specified number of seconds",
+      "threads"    => "View and manipulate background threads",
+      "unload"     => "Unload a framework plugin",
+      "unset"      => "Unsets one or more context-specific variables",
+      "unsetg"     => "Unsets one or more global variables",
+      "use"        => "Selects a module by name",
+      "version"    => "Show the framework and console library version numbers",
+      "spool"      => "Write console output into a file as well the screen"
     }
   end
 
@@ -780,6 +781,50 @@ def cmd_irb(*args)
     end
   end
 
+  def cmd_rename_job_help
+    print_line "Usage: rename_job [ID] [Name]"
+    print_line
+    print_line "Example: rename_job 0 \"meterpreter HTTPS special\""
+    print_line
+    print_line "Rename a job that's currently active."
+    print_line "You may use the jobs command to see what jobs are available."
+    print_line
+  end
+
+  def cmd_rename_job(*args)
+    if args.include?('-h') || args.length != 2 || args[0] !~ /^\d+$/
+      cmd_rename_job_help
+      return false
+    end
+
+    job_id   = args[0].to_s
+    job_name = args[1].to_s
+
+    unless framework.jobs[job_id]
+      print_error("Job #{job_id} does not exist.")
+      return false
+    end
+
+    # This is not respecting the Protected access control, but this seems to be the only way
+    # to rename a job. If you know a more appropriate way, patches accepted. 
+    framework.jobs[job_id].send(:name=, job_name)
+    print_status("Job #{job_id} updated")
+
+    true
+  end
+
+  #
+  # Tab completion for the rename_job command
+  #
+  # @param str [String] the string currently being typed before tab was hit
+  # @param words [Array<String>] the previously completed words on the command line.  words is always
+  # at least 1 when tab completion has reached this stage since the command itself has been completed
+
+  def cmd_rename_job_tabs(str, words)
+    return [] if words.length > 1
+    framework.jobs.keys
+  end
+
   def cmd_jobs_help
     print_line "Usage: jobs [options]"
     print_line