pwn 0.5.708 → 0.5.710

data/lib/pwn/plugins/nexpose_vuln_scan.rb

@@ -310,46 +310,62 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          nsc_obj = #{self}.login(
-            console_ip: 'required host/ip of Nexpose Console (server)',
-            username: 'required username',
-            password: 'optional password (will prompt if nil)'
+          # Run login and return its result
+          #{self}.login(
+            console_ip: 'required - required host/ip of Nexpose Console (server)',
+            username: 'required - required username',
+            password: 'optional - optional password (will prompt if nil)'
           )
-          puts nsc_obj.public_methods
 
-          all_individual_site_assets_arr = #{self}.list_all_individual_site_assets(
-            nsc_obj: 'required nsc_obj returned from login method',
-            site_name: 'required Nexpose site name to update (case-sensitive)'
+          # Run list all individual site assets and return its result
+          #{self}.list_all_individual_site_assets(
+            nsc_obj: 'required - required nsc_obj returned from login method',
+            site_name: 'required - required Nexpose site name to update (case-sensitive)'
           )
 
-          nsc_obj = #{self}.update_site_assets(
-            nsc_obj: 'required nsc_obj returned from login method',
-            site_name: 'required Nexpose site name to update (case-sensitive),
-            assets: 'required array of hashes containing called :ip => values being IP address (All IPs not included in the :assets parameter will be removed from Nexpose)'
+          # Run update site assets and return its result
+          #{self}.update_site_assets(
+            nsc_obj: 'required - required nsc_obj returned from login method',
+            site_name: 'required - required Nexpose site name to update (case-sensitive',
+            assets: 'required - required array of hashes containing called :ip => values being IP address (All IPs not included in the :assets parameter will be removed from Nexpose)'
           )
 
-          nsc_obj = #{self}.delete_site_assets_older_than(
-            nsc_obj: 'required nsc_obj returned from login method',
-            site_name: 'required Nexpose site name to update (case-sensitive),
-            days: 'required assets to remove older than number of days in this parameter'
+          # Run delete site assets older than and return its result
+          #{self}.delete_site_assets_older_than(
+            nsc_obj: 'required - required nsc_obj returned from login method',
+            site_name: 'required - required Nexpose site name to update (case-sensitive',
+            days: 'required - required assets to remove older than number of days in this parameter'
           )
 
-          nsc_obj = #{self}.scan_site_by_name(
-            nsc_obj: 'required nsc_obj returned from login method',
-            site_name: 'required Nexpose site name to scan (case-sensitive),
-            poll_interval: 'optional poll interval to check the completion status of the scan (defaults to 60 seconds)
+          # Run scan site by name and return its result
+          #{self}.scan_site_by_name(
+            nsc_obj: 'required - required nsc_obj returned from login method',
+            site_name: 'required - required Nexpose site name to scan (case-sensitive',
+            poll_interval: 'optional - optional poll interval to check the completion status of the scan (defaults to 3 minutes'
           )
 
+          # Run generate report via existing config and return its result
+          #{self}.generate_report_via_existing_config(
+            nsc_obj: 'required - required nsc_obj returned from login method',
+            config_id: 'optional - relevant r.config_id returned when invoking the block nsc_obj.reports.each {|r| puts \#{r.name} => \#{r.config_id}}'
+          )
+
+          # Run download recurring report and return its result
           #{self}.download_recurring_report(
-            nsc_obj: 'required nsc_obj returned from login method',
-            report_names: 'required array of report name/types to generate e.g. ['report.html', 'report.pdf', 'report.xml']',
-            poll_interval: 'optional poll interval to check the completion status of report generation (defaults to 60 seconds)
+            nsc_obj: 'required - required nsc_obj returned from login method',
+            report_names: 'required - required array of report name/types to generate e.g. [report.html, report.pdf, report.xml]',
+            poll_interval: 'optional - optional poll interval to check the completion status of report generation (defaults to 60 seconds'
           )
 
-          #{self}.logout(nsc_obj: 'required nsc_obj returned from login method')
+          # Run logout and return its result
+          #{self}.logout(
+            nsc_obj: 'required - required nsc_obj returned from login method'
+          )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/nmap_it.rb

@@ -127,52 +127,32 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          #{self}.port_scan do |nmap|
-            puts nmap.public_methods
-            nmap.connect_scan = true
-            nmap.service_scan = true
-            nmap.verbose = true
-            nmap.ports = [1..1024,1337]
-            nmap.targets = '127.0.0.1'
-            nmap.xml = '/tmp/nmap_port_scan_res.xml'
-          end
-
+          # nmap.connect_scan = true
           #{self}.port_scan(
-            targets: '127.0.0.1',
-            ports: '1-65535',
-            connect_scan: true,
-            service_scan: true,
-            script: 'vuln,safe',
-            xml: '/tmp/nmap_port_scan_res.xml'
+            targets: 'optional - hostname, IP, CIDR, or list of targets',
+            ports: 'optional - port, list, or range (e.g. 22,80,443 or 1-1024)',
+            connect_scan: 'optional - connect scan value consumed by #port_scan',
+            service_scan: 'optional - service scan value consumed by #port_scan',
+            script: 'optional - script value consumed by #port_scan',
+            xml: 'optional - /tmp/nmap_port_scan_res.xml'
           )
 
-          #{self}.parse_xml_results(:xml_file => 'required - path to nmap xml results') do |xml|
-            xml.each_host do |host|
-              puts host.ip
-
-              host.scripts.each do |name,output|
-                output.each_line { |line| puts line }
-              end
-
-              host.each_port do |port|
-                puts port
-
-                port.scripts.each do |name,output|
-                  puts name
-                  output.each_line { |line| puts line }
-                end
-              end
-            end
-          end
+          # xml.each_host do |host|
+          #{self}.parse_xml_results(
+            xml_file: 'optional - xml file value consumed by #parse_xml_results'
+          )
 
+          # Run diff xml results and return its result
           #{self}.diff_xml_results(
             xml_a: 'required - path to nmap xml results',
             xml_b: 'required - path to nmap xml results',
             diff: 'required - path to nmap xml results diff'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/nuclei.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'open3'
+
+module PWN
+  module Plugins
+    # nuclei wrapper: template/severity, JSONL findings.
+    module Nuclei
+      public_class_method def self.required_bins
+        %w[nuclei]
+      end
+
+      public_class_method def self.scan(opts = {})
+        PWN::Plugins::PreflightChecker.require_bin!(name: 'nuclei')
+        target = opts[:target] || opts[:url]
+        raise 'ERROR: target is required' if target.to_s.empty?
+
+        cmd = ['nuclei', '-u', target.to_s, '-jsonl', '-silent']
+        cmd += ['-severity', opts[:severity].to_s] if opts[:severity]
+        cmd += ['-t', opts[:templates].to_s] if opts[:templates]
+        cmd += ['-rate-limit', opts[:rate_limit].to_s] if opts[:rate_limit]
+        stdout, stderr, status = Open3.capture3(*cmd)
+        findings = stdout.each_line.filter_map do |ln|
+          JSON.parse(ln)
+        rescue JSON::ParserError
+          nil
+        end
+        { findings: to_findings(rows: findings), raw: findings, stderr: stderr, exit: status.exitstatus }
+      end
+
+      public_class_method def self.to_findings(opts = {})
+        Array(opts[:rows] || opts[:findings]).map do |r|
+          r = r.transform_keys(&:to_s) if r.is_a?(Hash)
+          info = r['info'] || {}
+          info = info.transform_keys(&:to_s) if info.is_a?(Hash)
+          {
+            title: info['name'] || r['template-id'] || 'nuclei finding',
+            severity: (info['severity'] || 'info').to_s,
+            url: r['matched-at'] || r['host'],
+            template: r['template-id'],
+            description: info['description']
+          }
+        end
+      end
+
+      public_class_method def self.to_defectdojo(opts = {})
+        to_findings(opts).map do |f|
+          { title: f[:title], severity: f[:severity], description: "#{f[:url]} #{f[:template]}".strip }
+        end
+      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 scan and return its result
+          #{self}.scan(
+            target: 'required - hostname, IP, or CIDR to scan (defaults to opts[:url])',
+            url: 'optional - HTTP(S) URL',
+            severity: 'optional - severity value consumed by #scan',
+            templates: 'optional - templates value consumed by #scan',
+            rate_limit: 'optional - requests per second passed to nuclei -rate-limit'
+          )
+
+          # Map nuclei JSONL rows into report-shaped finding hashes.
+          #{self}.to_findings(
+            rows: 'optional - Array of parsed nuclei JSONL objects',
+            findings: 'optional - alias for rows'
+          )
+
+          # Shape findings for a DefectDojo import payload.
+          #{self}.to_defectdojo(
+            rows: 'optional - Array of parsed nuclei JSONL objects',
+            findings: 'optional - alias for rows'
+          )
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
+      end
+    end
+  end
+end

data/lib/pwn/plugins/oauth2.rb

@@ -51,16 +51,22 @@ module PWN
       # Display Usage for this Module
 
       public_class_method def self.help
-        puts %{USAGE:
-          #{self}.decode(oauth2_token: 'required oauth2 token')"
+        puts "USAGE:
+          # Run decode and return its result
+          #{self}.decode(
+            oauth2_token: 'required - required oauth2 token'
+          )
 
+          # Run get value by key and return its result
           #{self}.get_value_by_key(
-            oauth2_token: 'required oauth2 token',
-            key: 'required oauth2 token key name located within the Base64 encoded token as symbol, e.g. :company_id'
+            oauth2_token: 'required - required oauth2 token',
+            key: 'required - required oauth2 token key name located within the Base64 encoded token as symbol, e.g. :company_id'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
-        }
+        "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/ocr.rb

@@ -31,12 +31,15 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run process and return its result
           #{self}.process(
             file: 'required - path to image file'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/open_api.rb

@@ -897,16 +897,19 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          openapi_spec = #{self}.generate_spec(
+          # Run generate spec and return its result
+          #{self}.generate_spec(
             spec_paths: 'required - array of OpenAPI file paths to merge',
             base_url: 'required - base URL for OpenAPI endpoints (e.g., http://fqdn.com)',
-            output_json_path: 'required - path to save the merged OpenAPI JSON file',
+            output_json_path: 'optional - path to save the merged OpenAPI JSON file',
             target_version: 'optional - target OpenAPI version (default: 3.0.3)',
             debug: 'optional - boolean to enable debug logging (default: false)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/openvas.rb

@@ -268,46 +268,54 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          task_xml_resp = #{self}.get_task_id(
-            task_name: 'required task name to start',
-            username: 'required username',
-            password: 'optional password (will prompt if nil)'
+          # Run get task id and return its result
+          #{self}.get_task_id(
+            task_name: 'required - required task name to start',
+            username: 'required - required username',
+            password: 'optional - optional password (will prompt if nil)'
           )
 
-          start_task_xml_resp = #{self}.start_task(
-            task_name: 'required task name to start',
-            username: 'required username',
-            password: 'optional password (will prompt if nil)'
+          # Run start task and return its result
+          #{self}.start_task(
+            task_name: 'required - required task name to start',
+            username: 'required - required username',
+            password: 'optional - optional password (will prompt if nil)'
           )
 
-          task_status = #{self}.get_task_status(
-            task_name: 'required task name to start',
-            username: 'required username',
-            password: 'optional password (will prompt if nil)'
+          # Run get task status and return its result
+          #{self}.get_task_status(
+            task_name: 'required - required task name to start',
+            username: 'required - required username',
+            password: 'optional - optional password (will prompt if nil)'
           )
 
-          last_report_id = #{self}.last_report_id(
-            task_name: 'required task name to start',
-            username: 'required username',
-            password: 'optional password (will prompt if nil)'
+          # Run last report id and return its result
+          #{self}.last_report_id(
+            task_name: 'required - required task name to start',
+            username: 'required - required username',
+            password: 'optional - optional password (will prompt if nil)'
           )
 
+          # Run save report and return its result
           #{self}.save_report(
-            report_type: 'required report type (csv|itg|pdf|txt|xml)',
-            report_id: 'required report id to save',
-            report_dir: 'required directory to save report',
-            username: 'required username',
-            password: 'optional password (will prompt if nil)',
-            report_filter: 'optional - results filter (Default: \"apply_overrides=0 levels=hml rows=1000 min_qod=70 first=1 sort-reverse=severity\")
+            report_type: 'required - required report type (csv|itg|pdf|txt|xml)',
+            report_id: 'required - required report id to save',
+            report_dir: 'required - required directory to save report',
+            username: 'required - required username',
+            password: 'optional - optional password (will prompt if nil)',
+            report_filter: 'optional - results filter (Default: apply_overrides=0 levels=hml rows=1000 min_qod=70 first=1 sort-reverse=severity'
           )
 
-          report_types = #{self}.get_report_types(
-            username: 'required username',
-            password: 'optional password (will prompt if nil)'
+          # Run get report types and return its result
+          #{self}.get_report_types(
+            username: 'required - required username',
+            password: 'optional - optional password (will prompt if nil)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end