pwn 0.5.708 → 0.5.710

data/lib/pwn/plugins/tor.rb

@@ -248,25 +248,30 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          tor_obj = #{self}.start(
+          # Run start and return its result
+          #{self}.start(
             ip: 'optional - IP address to listen (default: 127.0.0.1)',
-            port: 'optional - socks port to listen (default: 9050)',
-            ctrl_port: 'optional - tor control port to listen (default: 9051)',
-            net: 'optional - CIDR notation to accept connections (default: 127.0.0.1/32)',
+            port: 'optional - socks port to listen (default: 1024-65535)',
+            ctrl_port: 'optional - tor control port to listen (default: 1024-65535)',
+            net: 'optional - CIDR notation to accept connections (default: 127.0.0.0.1/32)',
             data_dir: 'optional - directory to keep tor session data (default: /tmp/tor_pwn-TIMESTAMP)'
           )
 
+          # Run switch exit node and return its result
           #{self}.switch_exit_node(
             tor_obj: 'required - tor_obj returned from #start method',
             response_timeout: 'optional - float in seconds to timeout (default: 3.0)'
           )
 
+          # Run stop and return its result
           #{self}.stop(
             tor_obj: 'required - tor_obj returned from #start method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/transparent_browser.rb

@@ -1561,188 +1561,143 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          browser_obj1 = #{self}.open(
+          # Open a session or connection and return a handle.
+          #{self}.open(
             browser_type: 'optional - :firefox|:chrome|:headless|:rest|:websocket (defaults to :chrome)',
-            proxy: 'optional scheme://proxy_host:port || tor (defaults to nil)',
+            proxy: 'optional - scheme://proxy_host:port || tor (defaults to nil)',
             devtools: 'optional - boolean (defaults to false)'
           )
-          browser = browser_obj1[:browser]
-          puts browser.public_methods
-
-          ********************************************************
-          * DevTools Interaction
-          * All DevTools Commands can be found here:
-          * https://chromedevtools.github.io/devtools-protocol/
-          * Examples
-          devtools = browser_obj1[:devtools]
-          puts devtools.public_methods
-          puts devtools.instance_variables
-          puts devtools.instance_variable_get('@session_id')
-
-          websocket = devtools.instance_variable_get('@ws')
-          puts websocket.public_methods
-          puts websocket.instance_variables
-          puts websocket.instance_variable_get('@messages')
-
-          * Tracing
-          devtools.send_cmd('Tracing.start')
-          devtools.send_cmd('Tracing.requestMemoryDump')
-          devtools.send_cmd('Tracing.end')
-          puts devtools.instance_variable_get('@messages')
-
-          * Network
-          devtools.send_cmd('Network.enable')
-          last_ws_resp = devtools.instance_variable_get('@messages').last if devtools.instance_variable_get('@messages').last['method'] == 'Network.webSocketFrameReceived'
-          puts last_ws_resp
-          devtools.send_cmd('Network.disable')
-
-          * Debugging DOM and Sending JavaScript to Console
-          devtools.send_cmd('Runtime.enable')
-          devtools.send_cmd('Console.enable')
-          devtools.send_cmd('DOM.enable')
-          devtools.send_cmd('Page.enable')
-          devtools.send_cmd('Log.enable')
-          devtools.send_cmd('Debugger.enable')
-          devtools.send_cmd('Debugger.pause')
-          step = 1
-          next_step = 60
-          loop do
-            devtools.send_cmd('Console.clearMessages')
-            devtools.send_cmd('Log.clear')
-            console_events = []
-            browser.driver.on_log_event(:console) { |event| console_events.push(event) }
-
-            devtools.send_cmd('Debugger.stepInto')
-            puts \"Step: \#{step}\"
-
-            this_document = devtools.send_cmd('DOM.getDocument')
-            puts \"This #document:\\n\#{this_document}\\n\\n\\n\"
-
-            console_cmd = {
-              expression: 'for(var pop_var in window) { if (window.hasOwnProperty(pop_var) && window[pop_var] != null) console.log(pop_var + \" = \" + window[pop_var]); }'
-            }
-            puts devtools.send_cmd('Runtime.evaluate', **console_cmd)
-
-            print '-' * 180
-            print \"\\n\"
-            console_events.each do |event|
-              puts event.args
-            end
-            puts \"Console Response Length: \#{console_events.length}\"
-            console_events_digest = OpenSSL::Digest::SHA256.hexdigest(
-              console_events.inspect
-            )
-            puts \"Console Events Array SHA256 Digest: \#{console_events_digest}\"
-            print '-' * 180
-            puts \"\\n\\n\\n\"
-
-            print \"Next Step in \"
-            next_step.downto(1) {|n| print \"\#{n} \"; sleep 1 }
-            puts 'READY!'
-            step += 1
-          end
-
-          devtools.send_cmd('Debugger.disable')
-          devtools.send_cmd('Log.disable')
-          devtools.send_cmd('Page.disable')
-          devtools.send_cmd('DOM.disable')
-          devtools.send_cmd('Console.disable')
-          devtools.send_cmd('Runtime.disable')
-          * End of DevTools Examples
-          ********************************************************
 
-          browser_obj1 = #{self}.dump_links(
-            browser_obj: 'required - browser_obj returned from #open method)'
+          # Run dump links and return its result
+          #{self}.dump_links(
+            browser_obj: 'optional - browser object returned from #open'
           )
 
-          browser_obj1 = #{self}.find_elements_by_text(
-            browser_obj: 'required - browser_obj returned from #open method)',
+          # Run find elements by text and return its result
+          #{self}.find_elements_by_text(
+            browser_obj: 'optional - browser object returned from #open',
             text: 'required - text to search for in the DOM'
           )
 
+          # Run type as human and return its result
           #{self}.type_as_human(
             string: 'required - string to type as human',
             rand_sleep_float: 'optional - float timing in between keypress (defaults to 0.09)'
-          ) {|char| browser_obj1.text_field(name: \"search\").send_keys(char) }
+          )
 
-          console_resp = #{self}.console(
-            browser_obj: 'required - browser_obj returned from #open method)',
+          # Run console and return its result
+          #{self}.console(
+            browser_obj: 'optional - browser object returned from #open',
             js: 'required - JavaScript expression to evaluate',
             return_to: 'optional - return to :console or :stdout (defaults to :console)'
           )
 
-          console_resp = #{self}.view_dom_mutations(
-            browser_obj: 'required - browser_obj returned from #open method)',
+          # Run view dom mutations and return its result
+          #{self}.view_dom_mutations(
+            browser_obj: 'required - browser_obj returned from #open method',
             index: 'optional - index of tab to switch to (defaults to active tab)',
-            target: 'optional - target JavaScript node to observe (defaults to document.body)'
+            target: 'optional - target JavaScript node to observe (defaults to document.body)',
+            observe_clobbering: 'optional - boolean to enable DOM Clobbering detection (defaults to true)',
+            observe_redirects: 'optional - boolean to enable Insecure Redirect detection (defaults to true)',
+            observe_resources: 'optional - boolean to enable resource load monitoring (defaults to true)'
           )
 
-          console_resp = #{self}.hide_dom_mutations(
-            browser_obj: 'required - browser_obj returned from #open method)',
+          # Run hide dom mutations and return its result
+          #{self}.hide_dom_mutations(
+            browser_obj: 'optional - browser object returned from #open',
             index: 'optional - index of tab to switch to (defaults to active tab)'
           )
 
+          # Run update about config and return its result
           #{self}.update_about_config(
-            browser_obj: 'required - browser_obj returned from #open method)',
+            browser_obj: 'optional - browser object returned from #open',
             key: 'required - key to update in about:config',
             value: 'required - value to set for key in about:config'
           )
 
-          tabs = #{self}.list_tabs(
+          # Run list tabs and return its result
+          #{self}.list_tabs(
             browser_obj: 'required - browser_obj returned from #open method)'
           )
 
-          tab = #{self}.jmp_tab(
+          # Run jmp tab and return its result
+          #{self}.jmp_tab(
             browser_obj: 'required - browser_obj returned from #open method)',
             index: 'optional - index of tab to switch to (defaults to switching to next tab)',
-            keyword: 'optional - keyword in title or url used to switch tabs (defaults to switching to next tab)',
+            keyword: 'optional - keyword in title or url used to switch tabs (defaults to switching to next tab)'
           )
 
-          tab = #{self}.new_tab(
+          # Run new tab and return its result
+          #{self}.new_tab(
             browser_obj: 'required - browser_obj returned from #open method)',
             url: 'optional - URL to open in new tab'
           )
 
-          tab = #{self}.close_tab(
+          # Run close tab and return its result
+          #{self}.close_tab(
             browser_obj: 'required - browser_obj returned from #open method)',
             index: 'optional - index of tab to close (defaults to closing active tab)',
             keyword: 'optional - keyword in title or url used to close tabs (defaults to closing active tab)'
           )
 
-          current_dom = #{self}.dom(
+          # Run dom and return its result
+          #{self}.dom(
+            browser_obj: 'required - browser_obj returned from #open method)'
+          )
+
+          # Run get page state and return its result
+          #{self}.get_page_state(
             browser_obj: 'required - browser_obj returned from #open method)'
           )
 
-          page_state = #{self}.get_page_state(
+          # Run devtools websocket messages and return its result
+          #{self}.devtools_websocket_messages(
             browser_obj: 'required - browser_obj returned from #open method)'
           )
 
+          # Run debugger and return its result
           #{self}.debugger(
             browser_obj: 'required - browser_obj returned from #open method)',
             action: 'optional - action to take :enable|:pause|:resume|:disable (Defaults to :enable)'
           )
 
+          # Run get targets and return its result
+          #{self}.get_targets(
+            browser_obj: 'required - browser_obj returned from #open method)'
+          )
+
+          # Run breakpoint locations and return its result
+          #{self}.breakpoint_locations(
+            browser_obj: 'required - browser_obj returned from #open method)'
+          )
+
+          # Run step and return its result
           #{self}.step(
             browser_obj: 'required - browser_obj returned from #open method)',
             action: 'optional - action to take :into|:out|:over (Defaults to :into)',
             steps: 'optional - number of steps taken (Defaults to 1)'
           )
 
+          # Run toggle devtools and return its result
           #{self}.toggle_devtools(
             browser_obj: 'required - browser_obj returned from #open method)'
           )
 
+          # Run jmp devtools panel and return its result
           #{self}.jmp_devtools_panel(
             browser_obj: 'required - browser_obj returned from #open method)',
             panel: 'optional - panel to switch to :elements|:inspector|:console|:debugger|:sources|:network'
           )
 
-          browser_obj1 = #{self}.close(
+          # Close a session previously returned by #open.
+          #{self}.close(
             browser_obj: 'required - browser_obj returned from #open method)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/tty_spinner.rb

@@ -163,10 +163,24 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          spin = #{self}.start
-          #{self}.stop(spin: spin)
+          # Run start and return its result
+          #{self}.start(
+            format: 'optional - TTY::Spinner format (defaults to :dots)',
+            output: 'optional - IO to draw on (defaults to $stderr)'
+          )
+
+          # Run stop and return its result
+          #{self}.stop(
+            spin: 'optional - TTY::Spinner from #start (no-op if nil)'
+          )
+
+          # Run halt all and return its result
           #{self}.halt_all!
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/twitter_api.rb

@@ -134,17 +134,21 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          bearer_token = #{self}.app_only_login(
+          # Run app only login and return its result
+          #{self}.app_only_login(
             consumer_key: 'required - consumer key for app-only authentication',
             consumer_secret: 'optional - consumer secret (will prompt if nil)'
           )
 
+          # Run app only logout and return its result
           #{self}.app_only_logout(
-            bearer_token: 'required bearer_token returned from #app_only_login method'
+            bearer_token: 'required - required bearer_token returned from #app_only_login method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/uri_scheme.rb

@@ -318,10 +318,13 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          uri_scheme_arr = #{self}.list_all_known
+          # Run list all known and return its result
+          #{self}.list_all_known
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/vault.rb

@@ -256,49 +256,58 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run refresh encryption secrets and return its result
           #{self}.refresh_encryption_secrets(
             file: 'required - file to encrypt with new key and iv',
             key: 'required - key to decrypt',
             iv: 'required - iv to decrypt'
           )
 
+          # Run create and return its result
           #{self}.create(
-            file: 'required - file to encrypt',
+            file: 'required - encrypted file to create',
             decryptor_file: 'optional - file to save the key && iv values'
           )
 
+          # Run decrypt and return its result
           #{self}.decrypt(
             file: 'required - file to decrypt',
             key: 'required - key to decrypt',
             iv: 'required - iv to decrypt'
           )
 
+          # Run dump and return its result
           #{self}.dump(
             file: 'required - file to dump',
             key: 'required - key to decrypt',
             iv: 'required - iv to decrypt',
-        #   search: 'optional - search for a specific string'
+            yaml: 'optional - dump as parsed yaml hash (default: true)'
           )
 
+          # Run edit and return its result
           #{self}.edit(
             file: 'required - file to edit',
             key: 'required - key to decrypt',
             iv: 'required - iv to decrypt',
-            editor: 'optional - editor to use (default: \"/usr/bin/vim\")'
+            editor: 'optional - editor to use (default: /usr/bin/vim)'
           )
 
+          # Run encrypt and return its result
           #{self}.encrypt(
             file: 'required - file to encrypt',
             key: 'required - key to decrypt',
             iv: 'required - iv to decrypt'
           )
 
+          # Run file encrypted and return its result
           #{self}.file_encrypted?(
             file: 'required - file to check if encrypted'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/vin.rb

@@ -317,46 +317,58 @@ module PWN
       # Display Usage for this Module
       public_class_method def self.help
         puts "USAGE:
-          manufacturers = #{self}.get_all_manufacturers
+          # Run get all manufacturers and return its result
+          #{self}.get_all_manufacturers
 
-          makes = #{self}.get_all_makes
+          # Run get all makes and return its result
+          #{self}.get_all_makes
 
-          wmis = #{self}.get_wmis_for_manufacturer(
+          # Run get wmis for manufacturer and return its result
+          #{self}.get_wmis_for_manufacturer(
             mfr: 'required - Mfr_CommonName returned from #get_all_manufacturers method'
           )
 
-          models = #{self}.decode_wmi(
-            wmi: 'required - WMI to decode (e.g. \"1FD\")'
+          # Run decode wmi and return its result
+          #{self}.decode_wmi(
+            wmi: 'required - WMI to decode (e.g. 1FD)'
           )
 
-          models = #{self}.decode_vin(
+          # Run decode vin and return its result
+          #{self}.decode_vin(
             vin: 'required - 17 character VIN to decode'
           )
 
-          models = #{self}.get_models_for_make(
+          # Run get models for make and return its result
+          #{self}.get_models_for_make(
             make: 'required - Make_Name returned from get_all_makes'
           )
 
-          models = #{self}.get_models_for_make_year(
+          # Run get models for make year and return its result
+          #{self}.get_models_for_make_year(
             make: 'required - Make_Name returned from get_all_makes',
             year: 'optional - e.g. 2023 (defaults to current year)'
           )
 
-          models = #{self}.get_vehicle_types_for_make(
+          # Run get vehicle types for make and return its result
+          #{self}.get_vehicle_types_for_make(
             make: 'required - Make_Name returned from get_all_makes'
           )
 
-          details = #{self}.get_manufacturer_details(
+          # Run get manufacturer details and return its result
+          #{self}.get_manufacturer_details(
             mfr: 'required - Mfr_Name returned from get_all_manufacturers'
           )
 
-          vin = #{self}.generate_vin(
-            mfr: 'required - manufacturer name (e.g., Mfr_CommonName from get_all_manufacturers)',
+          # Run generate vin and return its result
+          #{self}.generate_vin(
+            mfr: 'required - manufacturer name (i.e. Mfr_CommonName from #get_all_manufacturers)',
             year: 'optional - year of the vehicle (defaults to current year)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/voice.rb

@@ -119,26 +119,31 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run mutate and return its result
           #{self}.mutate(
             sox_path: 'optional - path to sox application (defaults to /usr/bin/sox)',
             pitch: 'optional - integer to alter voice input (defaults to -300)'
           )
 
-          response = #{self}.speech_to_text(
+          # Run speech to text and return its result
+          #{self}.speech_to_text(
             audio_file_path: 'required - path to audio file',
             whisper_path: 'optional - path to OpenAI whisper application (defaults to /usr/local/bin/whisper)',
             model: 'optional - transcribe model to use (defaults to tiny)',
             output_dir: 'optional - directory to output results (defaults to .)'
           )
 
+          # Run text to speech and return its result
           #{self}.text_to_speech(
             text_path: 'required - path to text file to speak',
             festival_path: 'optional - path to festival (defaults to /usr/bin/festival)',
-            voice: 'optional - voice to use (defaults to cmu_us_slt_arctic_hts)',
+            voice: 'optional - voice to use (defaults to cmu_us_slt_arctic_hts)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/volatility.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module PWN
+  module Plugins
+    # volatility3 wrapper.
+    module Volatility
+      public_class_method def self.required_bins
+        %w[vol]
+      end
+
+      public_class_method def self.run(opts = {})
+        bin = %w[vol volatility3 vol3].find { |b| PWN::Plugins::PreflightChecker.bin?(name: b) }
+        raise PWN::Plugins::PreflightChecker::MissingBinary, 'ERROR: volatility3 (vol) missing' unless bin
+
+        memory = opts[:memory] || opts[:file]
+        plugin = opts[:plugin] || 'windows.pslist'
+        raise 'ERROR: memory is required' if memory.to_s.empty?
+
+        stdout, stderr, status = Open3.capture3(bin, '-f', memory.to_s, plugin.to_s)
+        { stdout: stdout, stderr: stderr, exit: status.exitstatus }
+      end
+
+      public_class_method def self.yara(opts = {})
+        PWN::Plugins::PreflightChecker.require_bin!(name: 'yara')
+        rules = opts[:rules] || opts[:rule]
+        target = opts[:memory] || opts[:file] || opts[:path]
+        raise 'ERROR: rules and memory/file are required' if rules.to_s.empty? || target.to_s.empty?
+
+        stdout, stderr, status = Open3.capture3('yara', rules.to_s, target.to_s)
+        { stdout: stdout, stderr: stderr, exit: status.exitstatus }
+      end
+
+      public_class_method def self.authors
+        "AUTHOR(S):\n  0day Inc. <support@0dayinc.com>\n"
+      end
+
+      public_class_method def self.help
+        puts "USAGE:
+          # List host binaries this module expects to be installed.
+          #{self}.required_bins
+
+          # Run run and return its result
+          #{self}.run(
+            memory: 'required - memory value consumed by #run (defaults to opts[:file])',
+            file: 'optional - filesystem path',
+            plugin: 'required - plugin value consumed by #run (defaults to windows.pslist)'
+          )
+
+          # Scan a memory image with a yara rules file.
+          #{self}.yara(
+            rules: 'required - path to a .yar rules file',
+            rule: 'optional - alias for rules',
+            memory: 'required - memory image path',
+            file: 'optional - alias for memory',
+            path: 'optional - alias for memory'
+          )
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
+      end
+    end
+  end
+end

data/lib/pwn/plugins/vsphere.rb

@@ -62,19 +62,23 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          vsphere_obj = #{self}.login(
+          # Run login and return its result
+          #{self}.login(
             host: 'required - vsphere host or ip',
-            username: 'required - username',
+            username: 'required - username value consumed by #login',
             password: 'optional - password (will prompt if nil)',
-            insecure: 'optional - ignore ssl checks (defaults to false)
+            insecure: 'optional - ignore ssl checks (defaults to false'
           )
 
-          vsphere_obj = #{self}.logout(
-            vsphere_obj: 'required vsphere_obj returned from #login method'
+          # Run logout and return its result
+          #{self}.logout(
+            vsphere_obj: 'required - required vsphere_obj returned from #login method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end