Merge pull request rapid7#19939 from cgranleese-r7/fixes-modules-to-correctly-use-hash-with-report-note

Updates the `reports_note` method to require a Hash

Author: adfoster-r7

data/exploits/psnuffle/smb.rb

@@ -185,19 +185,19 @@ def parse_sessionsetup(pkt, s)
               report_note(
                 :host  => src_ip,
                 :type  => "smb_peer_os",
-                :data  => s[:peer_os]
+                :data  => { :peer_os => s[:peer_os] }
               ) if (s[:peer_os] and s[:peer_os].strip.length > 0)
 
               report_note(
                 :host  => src_ip,
                 :type  => "smb_peer_lm",
-                :data  => s[:peer_lm]
+                :data  => { :peer_lm => s[:peer_lm] }
               ) if (s[:peer_lm] and s[:peer_lm].strip.length > 0)
 
               report_note(
                 :host  => src_ip,
                 :type  => "smb_domain",
-                :data  => s[:domain]
+                :data  => { :domain => s[:domain] }
               ) if (s[:domain] and s[:domain].strip.length > 0)
 
             end

lib/msf/core/auxiliary/report.rb

@@ -515,7 +515,7 @@ def store_local(ltype=nil, ctype=nil, data=nil, filename=nil)
 
     # This will probably evolve into a new database table
     report_note(
-      :data => full_path.dup,
+      :data => { :full_path => full_path.dup },
       :type => "#{ltype}.localpath"
     )
 
@@ -590,4 +590,3 @@ def store_cred(opts={})
 
 end
 end
-

lib/msf/core/db_manager/note.rb

@@ -143,6 +143,14 @@ def report_note(opts)
     end
 
     ntype  = opts.delete(:type) || opts.delete(:ntype) || (raise RuntimeError, "A note :type or :ntype is required")
+
+    unless opts[:data].is_a?(Hash)
+      message = "[DEPRECATION] Using #{method.inspect} with a non-hash data value is deprecated, please raise a Github issue with this output. Called from: #{caller(1, stack_size).to_a}"
+      print_warning message
+      # Additionally write to ~/.msf4/logs/framework.log - as this gets attached to Github issues etc
+      elog(message)
+    end
+
     data   = opts[:data]
     note   = nil
 

lib/msf/core/exploit/remote/browser_autopwn2.rb

@@ -612,7 +612,7 @@ def log_click(ip, data='')
       report_note(
         :host => ip,
         :type => 'bap.clicks',
-        :data => data,
+        :data => { :csv_data => data },
         :update => :unique)
     end
 

lib/msf/core/exploit/remote/dns/enumeration.rb

@@ -246,7 +246,7 @@ def dns_get_srv(domain)
           }
           report_note(
             type: srv_record,
-            data: srv_record_data
+            data: { :srv_record_data => srv_record_data }
           )
         end
       end

lib/msf/core/exploit/remote/http_server.rb

@@ -381,7 +381,14 @@ def report_user_agent(address, request, client_opts={})
     report_note(
       :host => address,
       :type => 'http.request',
-      :data => "#{address}: #{request.method} #{request.resource} #{client[:os_name]} #{client[:ua_name]} #{client[:ua_ver]}",
+      :data => {
+        :address => address,
+        :method => request.method,
+        :resource => request.resource,
+        :os_name => client[:os_name],
+        :ua_name => client[:ua_name],
+        :ua_ver => client[:ua_ver]
+      },
       :update => :unique_data
     )
     return host.merge(client)

lib/msf/core/exploit/remote/smb/client/psexec.rb

@@ -233,7 +233,7 @@ def execute_command_payload(smbshare)
         :rport => simple.port,
         :type  => 'psexec_command',
         :name => command,
-        :data => output
+        :data => { :command_output => output }
       )
     end
   end

lib/msf/core/exploit/remote/wdbrpc_client.rb

@@ -64,7 +64,7 @@ def wdbrpc_client_connect
       :port   => rport,
       :proto  => 'udp',
       :type   => 'vxworks.target_info',
-      :data   => res,
+      :data   => { :target_info => res },
       :update => :unique
     )
   end
@@ -103,7 +103,7 @@ def wdbrpc_client_connect2
       :port   => rport,
       :proto  => 'udp',
       :type   => 'vxworks.target_info',
-      :data   => res,
+      :data   => { :target_info => res },
       :update => :unique
     )
   end
@@ -215,4 +215,3 @@ def rport
 
 end
 end
-

lib/msf/core/exploit/remote/x11/connect.rb

@@ -49,7 +49,7 @@ def x11_print_connection_info(connection, ip, port)
       sname: 'x11',
       port: port,
       type: 'x11.server_vendor',
-      data: "Open X Server (#{connection.body.vendor})"
+      data: { :server => connection.body.vendor }
     )
   end
 end

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

@@ -347,7 +347,7 @@ def change_host_data(host_ranges, host_data)
 
       framework.db.hosts(address: host_search).each do |host|
         framework.db.update_host(host_data.merge(id: host.id))
-        framework.db.report_note(host: host.address, type: "host.#{attribute}", data: host_data[attribute])
+        framework.db.report_note(host: host.address, type: "host.#{attribute}", data: { :host_data => host_data[attribute] })
       end
     end
   end