Class: Rex::Post::Meterpreter::Ui::Console::CommandDispatcher::Extapi::Window

Inherits:

Object

Object
Rex::Post::Meterpreter::Ui::Console::CommandDispatcher::Extapi::Window

show all

Includes:: Extensions::Extapi, Rex::Post::Meterpreter::Ui::Console::CommandDispatcher

Defined in:: lib/rex/post/meterpreter/ui/console/command_dispatcher/extapi/window.rb

Overview

Extended API window management user interface.

Constant Summary collapse

Klass =

Console::CommandDispatcher::Extapi::Window

@@window_enum_opts = Options for the window_enum command.

Rex::Parser::Arguments.new(
  '-h' => [ false, 'Help banner' ],
  '-p' => [ true, 'Parent window handle, used to enumerate child windows' ],
  '-u' => [ false, 'Include unknown/untitled windows in the result set' ],
  '-c' => [ true, 'Specify the window class name to display. e.g. Edit,Button etc.' ]
)

Constants included from Extensions::Extapi

Instance Attribute Summary

Attributes included from Ui::Text::DispatcherShell::CommandDispatcher

#shell, #tab_complete_items

Instance Method Summary collapse

#cmd_window_enum(*args) ⇒ Object

Enumerate top-level windows.
#commands ⇒ Object

List of supported commands.
#name ⇒ Object

Name for this dispatcher.
#window_enum_usage ⇒ Object

Methods included from Rex::Post::Meterpreter::Ui::Console::CommandDispatcher

check_hash, #client, #docs_dir, #filter_commands, #initialize, #log_error, #msf_loaded?, set_hash, #unknown_command

Methods included from Ui::Text::DispatcherShell::CommandDispatcher

#cmd_help, #cmd_help_help, #cmd_help_tabs, #deprecated_cmd, #deprecated_commands, #deprecated_help, #docs_dir, #help_to_s, included, #initialize, #print, #print_error, #print_good, #print_line, #print_status, #print_warning, #tab_complete_directory, #tab_complete_filenames, #tab_complete_generic, #tab_complete_source_address, #unknown_command, #update_prompt

Instance Method Details

#cmd_window_enum(*args) ⇒ `Object`

Enumerate top-level windows.

# File 'lib/rex/post/meterpreter/ui/console/command_dispatcher/extapi/window.rb', line 71

def cmd_window_enum(*args)
  parent_window = nil
  include_unknown = false
  window_class_name = nil

  @@window_enum_opts.parse(args) do |opt, _idx, val|
    case opt
    when '-u'
      include_unknown = true
    when '-p'
      parent_window = val.to_i
      if parent_window == 0
        window_enum_usage
        return true
      end
    when '-h'
      window_enum_usage
      return true
    when '-c'
      window_class_name = val.to_s
      if window_class_name == ''
        window_enum_usage
        return true
      end
    end
  end

  windows = client.extapi.window.enumerate(include_unknown, parent_window)

  header = parent_window ? "Child windows of #{parent_window}" : 'Top-level windows'
  columns = [ 'PID', 'Handle', 'ClassName', 'Title']
  table = Rex::Text::Table.new(
    'Header' => header,
    'Indent' => 0,
    'SortIndex' => columns.index('Handle'),
    'Columns' => columns
  )

  windows.each do |w|
    if window_class_name.nil?
      table << [w[:pid], w[:handle], w[:class_name], w[:title]]
    elsif (w[:class_name] == window_class_name)
      table << [w[:pid], w[:handle], w[:class_name], w[:title]]
    else
      next
    end
  end

  print_line
  print_line(table.to_s)

  if parent_window.nil?
    print_line("Total top-level Windows: #{windows.length}")
  else
    print_line("Total child Windows: #{windows.length}")
  end

  print_line

  return true
end

#commands ⇒ `Object`

List of supported commands.

# File 'lib/rex/post/meterpreter/ui/console/command_dispatcher/extapi/window.rb', line 26

def commands
  all = {
    'window_enum' => 'Enumerate all current open windows'
  }
  reqs = {
    'window_enum' => [COMMAND_ID_EXTAPI_WINDOW_ENUM]
  }
  filter_commands(all, reqs)
end

#name ⇒ `Object`

Name for this dispatcher



39
40
41

# File 'lib/rex/post/meterpreter/ui/console/command_dispatcher/extapi/window.rb', line 39

def name
  'Extapi: Window Management'
end

#window_enum_usage ⇒ `Object`

# File 'lib/rex/post/meterpreter/ui/console/command_dispatcher/extapi/window.rb', line 53

def window_enum_usage
  print(
    "\nUsage: window_enum [-h] [-p parent_window] [-u]\n\n" \
    "Enumerate the windows on the target.\n\n" \
    "Enumeration returns the Process ID and Window Handle for each window\n" \
    "found. The Window Handle can be used for further calls to window_enum\n" \
    "or the railgun API.\n" +
    @@window_enum_opts.usage +
    "Note: Not all windows can be enumerated. An attempt to enumerate\n" \
    "      the children of such a window will result in a failure with the\n" \
    "      message \"Operation failed: The parameter is incorrect.\"\n"\
    "      Enumerable maximum text length is 256.\n\n"
  )
end