Module: Msf::Ui::Debug

Defined in:
lib/msf/ui/debug.rb

Overview

Displays Metasploit information useful for Debugging.

Constant Summary collapse

COMMAND_HISTORY_TOTAL =
50
ERROR_TOTAL =
10
LOG_LINE_TOTAL =
50
'https://github.com/rapid7/metasploit-framework/issues/new/choose'
PREAMBLE =
<<~PREMABLE
  Please provide the below information in any Github issues you open. New issues can be opened here #{ISSUE_LINK.dup}
  %red%undENSURE YOU HAVE REMOVED ANY SENSITIVE INFORMATION BEFORE SUBMITTING!%clr

  ===8<=== CUT AND PASTE EVERYTHING BELOW THIS LINE ===8<===


PREMABLE

Class Method Summary collapse

Class Method Details

.all(framework, driver) ⇒ Object


33
34
35
36
37
38
39
40
41
42
# File 'lib/msf/ui/debug.rb', line 33

def self.all(framework, driver)
  all_information = preamble
  all_information << datastore(framework, driver)
  all_information << history(driver)
  all_information << errors
  all_information << logs
  all_information << versions(framework)

  all_information
end

.datastore(framework, driver) ⇒ Object


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/msf/ui/debug.rb', line 44

def self.datastore(framework, driver)

  # Generate an ini with the existing config file
  ini = Rex::Parser::Ini.new(Msf::Config.config_file)

  # Delete all groups from the config ini that potentially have more up to date information
  ini.keys.each do |key|
    unless key.start_with?("framework/database") || key.start_with?("framework/features")
      ini.delete(key)
    end
  end

  # Retrieve and add more up to date information
  add_hash_to_ini_group(ini, framework.datastore, driver.get_config_core)
  add_hash_to_ini_group(ini, driver.get_config, driver.get_config_group)

  if driver.active_module
    add_hash_to_ini_group(ini, driver.active_module.datastore.dup, driver.active_module.refname)
  end

  # Filter credentials
  ini.each do |key, value|
    if key =~ %r{^framework/database/}
      value.transform_values! { '[Filtered]' }
    end
  end

  if ini.to_s.empty?
    content = 'The local config file is empty, no global variables are set, and there is no active module.'
  else
    content = ini.to_s
  end

  build_section(
    'Module/Datastore',
    'The following global/module datastore, and database setup was configured before the issue occurred:',
    content
  )
rescue StandardError => e
  section_build_error('Failed to extract Datastore', e)
end

.errorsObject


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/msf/ui/debug.rb', line 106

def self.errors

  errors = File.read(File.join(Msf::Config.log_directory, 'framework.log'))

  # Returns any error logs in framework.log file as an array
  # "[mm/dd/yyyy hh:mm:ss] [e([ANY_NUMBER])]" Indicates the start of an error message
  # The end of an error message is indicated by the start of the next log message [mm/dd/yyyy hh:mm:ss] [[ANY_LETTER]([ANY_NUMBER])]
  #
  #
  # The below example framework.log will only return three separate errors, and their accompanying traces:
  #
  # [05/15/2020 14:13:38] [e(0)] core: [-] Error during IRB: undefined method `[]' for nil:NilClass
  #
  # [06/19/2020 12:05:02] [i(0)] core: Trying to continue despite failed database creation: could not connect to server: Connection refused
  # 	Is the server running on host "127.0.0.1" and accepting
  # 	TCP/IP connections on port 5433?
  #
  # [05/15/2020 14:19:20] [e(0)] core: [-] Error while running command debug: can't modify frozen String
  # Call stack:
  # /Users/Shared/Relocated_Items/Security/rapid7/metasploit-framework/lib/msf/ui/debug.rb:33:in `get_all'
  # /Users/Shared/Relocated_Items/Security/rapid7/metasploit-framework/lib/msf/ui/console/command_dispatcher/core.rb:318:in `cmd_debug'
  # /Users/Shared/Relocated_Items/Security/rapid7/metasploit-framework/lib/rex/ui/text/dispatcher_shell.rb:523:in `run_command'
  # /Users/Shared/Relocated_Items/Security/rapid7/metasploit-framework/lib/rex/ui/text/dispatcher_shell.rb:474:in `block in run_single'
  # /Users/Shared/Relocated_Items/Security/rapid7/metasploit-framework/lib/rex/ui/text/dispatcher_shell.rb:468:in `each'
  # /Users/Shared/Relocated_Items/Security/rapid7/metasploit-framework/lib/rex/ui/text/dispatcher_shell.rb:468:in `run_single'
  # /Users/Shared/Relocated_Items/Security/rapid7/metasploit-framework/lib/rex/ui/text/shell.rb:158:in `run'
  # /Users/Shared/Relocated_Items/Security/rapid7/metasploit-framework/lib/metasploit/framework/command/console.rb:48:in `start'
  # /Users/Shared/Relocated_Items/Security/rapid7/metasploit-framework/lib/metasploit/framework/command/base.rb:82:in `start'
  #
  # [06/19/2020 11:51:44] [d(2)] core: Stager osx/armle/reverse_tcp and stage osx/x64/meterpreter have incompatible architectures: armle - x64
  #
  # [05/15/2020 14:23:55] [e(0)] core: [-] Error during IRB: undefined method `[]' for nil:NilClass
  res = errors.scan(%r|\[\d{2}/\d{2}/\d{4} \d{2}:\d{2}:\d{2}\] \[e\(\d+\)\] (?:(?!\[\d{2}/\d{2}/\d{4} \d{2}:\d{2}:\d{2}\] \[[A-Za-z]\(\d+\)\]).)+|m)

  if res.empty?
    return build_section(
      'Errors',
      'The following errors occurred before the issue occurred:',
      'The error log file was empty'
    )
  end

  # Scan returns each error as a single item array
  res.flatten!

  errors_str = concat_str_array_from_last_idx(res, ERROR_TOTAL)
  build_section(
    'Errors',
    'The following errors occurred before the issue occurred:',
    errors_str
  )
rescue StandardError => e
  section_build_error('Failed to extract Errors', e)

end

.history(driver) ⇒ Object


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/msf/ui/debug.rb', line 86

def self.history(driver)
  end_pos = Readline::HISTORY.length - 1
  start_pos = end_pos - COMMAND_HISTORY_TOTAL > driver.hist_last_saved ? end_pos - (COMMAND_HISTORY_TOTAL - 1) : driver.hist_last_saved

  commands = ''
  while start_pos <= end_pos
    # Formats command position in history to 6 characters in length
    commands += "#{'%-6.6s' % start_pos.to_s} #{Readline::HISTORY[start_pos]}\n"
    start_pos += 1
  end

  build_section(
    'History',
    'The following commands were ran during the session and before this issue occurred:',
    commands
  )
rescue StandardError => e
  section_build_error('Failed to extract History', e)
end

25
26
27
# File 'lib/msf/ui/debug.rb', line 25

def self.issue_link
  return ISSUE_LINK.dup
end

.logsObject


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/msf/ui/debug.rb', line 162

def self.logs

  log_lines = File.readlines(File.join(Msf::Config.log_directory, 'framework.log'))

  logs_str = concat_str_array_from_last_idx(log_lines, LOG_LINE_TOTAL)

  build_section(
    'Logs',
    'The following logs were recorded before the issue occurred:',
    logs_str
  )
rescue StandardError => e
  section_build_error('Failed to extract Logs', e)

end

.preambleObject


29
30
31
# File 'lib/msf/ui/debug.rb', line 29

def self.preamble
  return PREAMBLE.dup
end

.versions(framework) ⇒ Object


178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/msf/ui/debug.rb', line 178

def self.versions(framework)

  str = <<~VERSIONS
    Framework: #{framework.version}
    Ruby: #{RUBY_DESCRIPTION}
    Install Root: #{Msf::Config.install_root}
    Session Type: #{db_connection_info(framework)}
    Install Method: #{installation_method}
  VERSIONS

  build_section('Version/Install', 'The versions and install method of your Metasploit setup:', str)
rescue StandardError => e
  section_build_error('Failed to extract Versions', e)
end