pwn 0.5.708 → 0.5.710

data/lib/pwn/plugins/xxd.rb

@@ -95,6 +95,7 @@ module PWN
       #   start_addr: 'required - start address to evaluate',
       #   target_addr: 'required - memory address to set breakpoint'
       # )
+      # Run calc addr offset and return its result
       # ^^^ Instructions for #{self}.calc_addr_offset:
       # This is useful for calculating address offsets of known functions in debuggers
       # to set breakpoints of instructions that are not known at runtime.
@@ -247,75 +248,43 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          hexdump = #{self}.dump(
+          # Run dump and return its result
+          #{self}.dump(
             file: 'required - path to binary file to dump',
             hashed: 'optional - return hexdump as hash instead of string (default: false)'
           )
 
-          hexdump = #{self}.fill_range_w_byte(
+          # Run fill range w byte and return its result
+          #{self}.fill_range_w_byte(
             hexdump: 'required - hexdump returned from #dump method',
             start_addr: 'required - start address to fill with byte',
             end_addr: 'required - end address to fill with byte',
             byte: 'required - byte to fill range with'
           )
 
-          hex_offset = #{self}.calc_addr_offset(
+          # Run calc addr offset and return its result
+          #{self}.calc_addr_offset(
             start_addr: 'required - start address to evaluate',
             target_addr: 'required - memory address to set breakpoint'
           )
 
-          # ^^^ Instructions for #{self}.calc_addr_offset:
-          # This is useful for calculating address offsets of known functions in debuggers
-          # to set breakpoints of instructions that are not known at runtime.
-          # 1. Set a breakpoint at main and record its address - this is the start_addr.
-          #    For example in r2:
-          #    ```
-          #    [0x00001050]> db main
-          #    [0x00001050]> ood
-          #    [0x7fd16122b360]> dc
-          #    INFO: hit breakpoint at: 0x562e8547d139
-          #    [0x562e8547d139]> db
-          #    ```
-          # 2. Populate start_addr w/ address (i.e. '0x562e8547d139') of a known function (i.e. main)
-          # 3. Step down to the instruction where you want to set a breakpoint. Record its address...
-          #    this is the target_addr.
-          #    ```
-          #    [0x562e8547d139]> v
-          #    <step through to the target instruction via F7/F8>
-          #    ```
-          # 4. Get the hex offset value by calling #{self}.calc_addr_offset method
-          # 5. Future breakpoints can be calculated by adding the hex offset to the
-          #    updated start_addr (which changes every time the binary is executed).
-          #    If the offset returned is `0x00000ec2`, a breakpoint for the target
-          #    instruction can be set in r2 via:
-          #    ```
-          #    [0x00001050]> ood
-          #    [0x7f1a45bea360]> db main
-          #    [0x7f1a45bea360]> db (main)+0x00000ec2
-          #    [0x7f1a45bea360]> db
-          #    0x558eebd75139 - 0x558eebd7513a 1 --x sw break enabled valid ...
-          #    0x558eebd75ffb - 0x558eebd75ffc 1 --x sw break enabled valid ...
-          #    [0x7f1a45bea360]> dc
-          #    INFO: hit breakpoint at: 0x55ee0a0e5139
-          #    [0x55ee0a0e5139]> dc
-          #    INFO: hit breakpoint at: 0x5558c3101ffb
-          #    [0x5558c3101ffb]> v
-          #    <step through via F7, F8, F9, etc. to get to desired instruction>
-          #    ```
-
+          # Run reverse hex string and return its result
           #{self}.reverse_hex_string(
-            string: 'required - continuous hex string to reverse (i.e. \"68656c6f\")',
+            string: 'required - continuous hex string to reverse (i.e. 68656c6c6f)',
             file: 'required - path to binary file to dump'
           )
 
+          # Run reverse dump and return its result
           #{self}.reverse_dump(
             hexdump: 'required - hexdump returned from #dump method',
             file: 'required - path to binary file to dump',
             byte_chunks: 'optional - if set, will write n byte chunks of hexdump to multiple files'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/zaproxy.rb

@@ -749,18 +749,18 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          zap_obj = #{self}.start(
+          # Run start and return its result
+          #{self}.start(
             api_key: 'required - api key for API authorization',
             zap_bin_path: 'optional - path to zap.sh file',
-            headless: 'optional - run zap headless if set to true',
-            proxy: 'optional - change local zap proxy listener (defaults to http://127.0.0.1:<Random 1024-65535>)'
-          )
-
-          #{self}.spider(
-            zap_obj: 'required - zap_obj returned from #open method',
-            target_url: 'required - url to spider'
+            headless: 'optional - run zap headless if set to true (defaults to false)',
+            browser_type: 'optional - defaults to :firefox.  See PWN::Plugins::TransparentBrowser.help for a list of types',
+            proxy: 'optional - change local zap proxy listener (defaults to http://127.0.0.1:<Random 1024-65535>)',
+            zap_ip: 'optional - zap ip value consumed by #start',
+            zap_port: 'optional - zap port value consumed by #start'
           )
 
+          # Run import openapi to sitemap and return its result
           #{self}.import_openapi_to_sitemap(
             zap_obj: 'required - zap_obj returned from #open method',
             openapi_spec: 'required - path to OpenAPI JSON or YAML spec file',
@@ -768,52 +768,62 @@ module PWN
             target_regex: 'optional - url regex to inject additional_http_headers into (e.g. https://test.domain.local.*)'
           )
 
+          # Run get sitemap and return its result
           #{self}.get_sitemap(
             zap_obj: 'required - zap_obj returned from #open method',
             keyword: 'optional - string to search for in the sitemap entries (defaults to nil)',
             return_as: 'optional - :base64 or :har (defaults to :base64)'
           )
 
+          # Run add to scope and return its result
           #{self}.add_to_scope(
             zap_obj: 'required - zap_obj returned from #open method',
             target_regex: 'required - url regex to add to scope (e.g. https://test.domain.local.*)',
             context_name: 'optional - context name to add target_regex to (defaults to Default Context)'
           )
 
+          # Run requester and return its result
           #{self}.requester(
             zap_obj: 'required - zap_obj returned from #open method',
             har_entry: 'required - har entry (e.g. from #get_sitemap method method)',
-            redirect: 'optional - follow redirects if set to true (defaults to true)'
+            redirect: 'optional - follow redirects if set to true (defaults to false)'
           )
 
-          json_sitemap = #{self}.spider(
-            zap_obj: 'required - zap_obj returned from #open method'
+          # Run spider and return its result
+          #{self}.spider(
+            zap_obj: 'required - zap_obj returned from #open method',
+            target_url: 'required - url to spider'
           )
 
+          # Run inject additional http headers and return its result
           #{self}.inject_additional_http_headers(
             zap_obj: 'required - zap_obj returned from #open method',
             target_regex: 'required - url regex to inject headers into (e.g. https://test.domain.local.*)',
             headers: 'required - hash of additional headers to inject into each request'
           )
 
+          # Run active scan and return its result
           #{self}.active_scan(
-            zap_obj: 'required - zap_obj returned from #open method'
+            zap_obj: 'required - zap_obj returned from #open method',
             target_url: 'required - url to scan',
             exclude_paths: 'optional - array of paths to exclude from scan (default: [])',
             scan_policy: 'optional - scan policy to use (defaults to Default Policy)'
           )
 
-          json_alerts = #{self}.get_alerts(
-            zap_obj: 'required - zap_obj returned from #open method'
+          # Run get alerts and return its result
+          #{self}.get_alerts(
+            zap_obj: 'required - zap_obj returned from #open method',
             target_url: 'required - base url to return alerts'
           )
 
-          report_path = #{self}.generate_scan_report(
+          # Run generate scan report and return its result
+          #{self}.generate_scan_report(
             zap_obj: 'required - zap_obj returned from #open method',
             output_dir: 'required - directory to save report',
             report_type: 'required - <:html|:markdown|:xml>'
           )
 
+          # Run breakpoint and return its result
           #{self}.breakpoint(
             zap_obj: 'required - zap_obj returned from #open method',
             regex_type: 'required - :url, :request_header, :request_body, :response_header or :response_body',
@@ -821,18 +831,22 @@ module PWN
             enabled: 'optional - boolean (defaults to true)'
           )
 
+          # Run tamper and return its result
           #{self}.tamper(
             zap_obj: 'required - zap_obj returned from #open method',
             domain: 'required - FQDN to tamper (e.g. test.domain.local)',
             enabled: 'optional - boolean (defaults to true)'
           )
 
+          # Run stop and return its result
           #{self}.stop(
-            zap_obj: 'required - zap_obj returned from #start method'
+            zap_obj: 'required - zap_obj returned from #open method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins.rb

@@ -6,7 +6,10 @@ module PWN
   # http://www.rubyinside.com/ruby-techniques-revealed-autoload-1652.html
   module Plugins
     autoload :Android, 'pwn/plugins/android'
+    autoload :AFLplusplus, 'pwn/plugins/aflplusplus'
+    autoload :ArtifactRegistry, 'pwn/plugins/artifact_registry'
     autoload :Assembly, 'pwn/plugins/assembly'
+    autoload :BinaryParser, 'pwn/plugins/binary_parser'
     autoload :AuthenticationHelper, 'pwn/plugins/authentication_helper'
     autoload :BareSIP, 'pwn/plugins/baresip'
     autoload :BasicAuth, 'pwn/plugins/basic_auth'
@@ -16,6 +19,8 @@ module PWN
     autoload :BusPirate, 'pwn/plugins/bus_pirate'
     autoload :Char, 'pwn/plugins/char'
     autoload :CreditCard, 'pwn/plugins/credit_card'
+    autoload :CredentialAttack, 'pwn/plugins/credential_attack'
+    autoload :PreflightChecker, 'pwn/plugins/preflight_checker'
     autoload :PWNLogger, 'pwn/plugins/pwn_logger'
     autoload :DAOLDAP, 'pwn/plugins/dao_ldap'
     autoload :DAOMongo, 'pwn/plugins/dao_mongo'
@@ -24,9 +29,13 @@ module PWN
     autoload :DefectDojo, 'pwn/plugins/defect_dojo'
     autoload :DetectOS, 'pwn/plugins/detect_os'
     autoload :EIN, 'pwn/plugins/ein'
+    autoload :ExploitDB, 'pwn/plugins/exploit_db'
     autoload :FileFu, 'pwn/plugins/file_fu'
     autoload :Fuzz, 'pwn/plugins/fuzz'
+    autoload :Frida, 'pwn/plugins/frida'
+    autoload :ExploitDev, 'pwn/plugins/exploit_dev'
     autoload :Git, 'pwn/plugins/git'
+    autoload :GDB, 'pwn/plugins/gdb'
     autoload :Github, 'pwn/plugins/github'
     autoload :GoogleWorkspace, 'pwn/plugins/google_workspace'
     autoload :HackerOne, 'pwn/plugins/hacker_one'
@@ -34,7 +43,9 @@ module PWN
     autoload :IPInfo, 'pwn/plugins/ip_info'
     autoload :IRC, 'pwn/plugins/irc'
     autoload :Jenkins, 'pwn/plugins/jenkins'
+    autoload :K8s, 'pwn/plugins/k8s'
     autoload :JiraDataCenter, 'pwn/plugins/jira_data_center'
+    autoload :Jobs, 'pwn/plugins/jobs'
     autoload :JSONPathify, 'pwn/plugins/json_pathify'
     autoload :Log, 'pwn/plugins/log'
     autoload :MailAgent, 'pwn/plugins/mail_agent'
@@ -44,6 +55,7 @@ module PWN
     autoload :NessusCloud, 'pwn/plugins/nessus_cloud'
     autoload :NexposeVulnScan, 'pwn/plugins/nexpose_vuln_scan'
     autoload :NmapIt, 'pwn/plugins/nmap_it'
+    autoload :Nuclei, 'pwn/plugins/nuclei'
     autoload :OAuth2, 'pwn/plugins/oauth2'
     autoload :OCR, 'pwn/plugins/ocr'
     autoload :OpenAPI, 'pwn/plugins/open_api'
@@ -52,15 +64,20 @@ module PWN
     autoload :PDFParse, 'pwn/plugins/pdf_parse'
     autoload :Pony, 'pwn/plugins/pony'
     autoload :PS, 'pwn/plugins/ps'
+    autoload :ProcessTube, 'pwn/plugins/process_tube'
     autoload :RabbitMQ, 'pwn/plugins/rabbit_mq'
+    autoload :Radare2, 'pwn/plugins/radare2'
+    autoload :Recon, 'pwn/plugins/recon'
     autoload :REPL, 'pwn/plugins/repl'
     autoload :ScannableCodes, 'pwn/plugins/scannable_codes'
+    autoload :Semgrep, 'pwn/plugins/semgrep'
     autoload :Serial, 'pwn/plugins/serial'
     autoload :Shodan, 'pwn/plugins/shodan'
     autoload :SlackClient, 'pwn/plugins/slack_client'
     autoload :Sock, 'pwn/plugins/sock'
     autoload :Spider, 'pwn/plugins/spider'
     autoload :SSN, 'pwn/plugins/ssn'
+    autoload :Sqlmap, 'pwn/plugins/sqlmap'
     autoload :ThreadPool, 'pwn/plugins/thread_pool'
     autoload :Tor, 'pwn/plugins/tor'
     autoload :TransparentBrowser, 'pwn/plugins/transparent_browser'
@@ -70,6 +87,7 @@ module PWN
     autoload :Vault, 'pwn/plugins/vault'
     autoload :VIN, 'pwn/plugins/vin'
     autoload :Voice, 'pwn/plugins/voice'
+    autoload :Volatility, 'pwn/plugins/volatility'
     autoload :Vsphere, 'pwn/plugins/vsphere'
     autoload :XXD, 'pwn/plugins/xxd'
     autoload :Zaproxy, 'pwn/plugins/zaproxy'
@@ -83,6 +101,10 @@ module PWN
     end
 
     public_class_method def self.help
+      puts "USAGE:
+        # Display a List of Every PWN::Plugins Module
+        #{self}.authors
+      "
       constants.sort
     end
   end

data/lib/pwn/reports/ai_red_team.rb

@@ -415,13 +415,17 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run generate and return its result
           #{self}.generate(
-            dir_path: dir_path,
-            results_hash: results_hash
+            dir_path: 'optional - Directory path to save the report (defaults to .)',
+            results_hash: 'optional - Hash containing the results of the AI RedTeam analysis (defaults to empty hash structure)',
+            report_name: 'optional - Name of the report file (defaults to current directory name)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/csv.rb

@@ -31,7 +31,14 @@ module PWN
       end
 
       public_class_method def self.help
-        puts "USAGE:\n  #{self}.generate(\n    path: '/tmp/report.csv',\n    results_hash: {}\n  )\n\n  #{self}.authors\n"
+        puts "USAGE:
+          # Run generate and return its result
+          #{self}.generate
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/fuzz.rb

@@ -314,14 +314,17 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run generate and return its result
           #{self}.generate(
-            dir_path: dir_path,
-            results_hash: results_hash,
+            dir_path: 'required - dir path value consumed by #generate',
+            results_hash: 'optional - results hash value consumed by #generate',
             char_encoding: 'optional - character encoding returned by PWN::Plugins::Char.list_encoders (defaults to UTF-8)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/html.rb

@@ -51,7 +51,14 @@ module PWN
       end
 
       public_class_method def self.help
-        puts "USAGE:\n  #{self}.generate(\n    path: '/tmp/report.html',\n    results_hash: {}\n  )\n\n  #{self}.authors\n"
+        puts "USAGE:
+          # Run generate and return its result
+          #{self}.generate
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/html_footer.rb

@@ -148,12 +148,13 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          #{self}.generate(
-            column_names: 'Array of Column Names to use in the report table',
-            driver_src_uri: 're
+          # Run generate and return its result
+          #{self}.generate
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/html_header.rb

@@ -259,12 +259,16 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run generate and return its result
           #{self}.generate(
-            column_names: 'Array of Column Names to use in the report table',
-            driver_src_uri: 're
+            column_names: 'required - array of column names to use in the report table (defaults to [])',
+            driver_src_uri: 'required - pwn driver source code uri'
+          )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/json.rb

@@ -25,7 +25,14 @@ module PWN
       end
 
       public_class_method def self.help
-        puts "USAGE:\n  #{self}.generate(\n    path: '/tmp/report.json',\n    results_hash: {}\n  )\n\n  #{self}.authors\n"
+        puts "USAGE:
+          # Run generate and return its result
+          #{self}.generate
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/markdown.rb

@@ -33,7 +33,14 @@ module PWN
       end
 
       public_class_method def self.help
-        puts "USAGE:\n  #{self}.generate(\n    path: '/tmp/report.md',\n    results_hash: {}\n  )\n\n  #{self}.authors\n"
+        puts "USAGE:
+          # Run generate and return its result
+          #{self}.generate
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/pdf.rb

@@ -86,7 +86,14 @@ module PWN
       end
 
       public_class_method def self.help
-        puts "USAGE:\n  #{self}.generate(\n    path: '/tmp/report.pdf',\n    results_hash: {}\n  )\n\n  #{self}.authors\n"
+        puts "USAGE:
+          # Run generate and return its result
+          #{self}.generate
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/phone.rb

@@ -371,13 +371,16 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run generate and return its result
           #{self}.generate(
-            dir_path: dir_path,
-            results_hash: results_hash
+            dir_path: 'required - dir path value consumed by #generate',
+            results_hash: 'optional - results hash value consumed by #generate'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/sast.rb

@@ -422,13 +422,17 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run generate and return its result
           #{self}.generate(
-            dir_path: dir_path,
-            results_hash: results_hash
+            dir_path: 'optional - Directory path to save the report (defaults to .)',
+            results_hash: 'optional - Hash containing the results of the SAST analysis (defaults to empty hash structure)',
+            report_name: 'optional - Name of the report file (defaults to current directory name)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/uri_buster.rb

@@ -322,13 +322,16 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run generate and return its result
           #{self}.generate(
-            dir_path: dir_path,
-            results_hash: results_hash
+            dir_path: 'required - dir path value consumed by #generate',
+            results_hash: 'optional - results hash value consumed by #generate'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports/xml.rb

@@ -37,7 +37,14 @@ module PWN
       end
 
       public_class_method def self.help
-        puts "USAGE:\n  #{self}.generate(\n    path: '/tmp/report.xml',\n    results_hash: {}\n  )\n\n  #{self}.authors\n"
+        puts "USAGE:
+          # Run generate and return its result
+          #{self}.generate
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
       end
     end
   end

data/lib/pwn/reports.rb

@@ -74,6 +74,25 @@ module PWN
     end
 
     public_class_method def self.help
+      puts "USAGE:
+        # Run resolve path and return its result
+        #{self}.resolve_path(
+          path: 'required - filesystem path to read or write',
+          ext: 'optional - ext value consumed by #resolve_path',
+          dir_path: 'optional - dir path value consumed by #resolve_path',
+          report_name: 'optional - report name value consumed by #resolve_path'
+        )
+
+        # Run report payload and return its result
+        #{self}.report_payload(
+          results_hash: 'optional - results hash value consumed by #report_payload',
+          title: 'optional - title value consumed by #report_payload',
+          executive_summary: 'optional - executive summary value consumed by #report_payload'
+        )
+
+        # Print the AUTHOR(S) string for this module.
+        #{self}.authors
+      "
       constants.sort
     end
   end

data/lib/pwn/sast/amqp_connect_as_guest.rb

@@ -65,13 +65,19 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          sast_arr = #{self}.scan(
-            dir_path: 'optional path to dir defaults to .',
-            git_repo_root_uri: 'optional http uri of git repo scanned'
+          # Run scan and return its result
+          #{self}.scan(
+            dir_path: 'optional - optional path to dir defaults to .',
+            git_repo_root_uri: 'optional - optional http uri of git repo scanned'
           )
 
+          # Used primarily to map NIST 800-53 Revision 4 Security Controls
+          #{self}.security_references
+
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/sast/apache_file_system_util_api.rb

@@ -63,13 +63,19 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          sast_arr = #{self}.scan(
-            :dir_path => 'optional path to dir defaults to .',
-            :git_repo_root_uri => 'optional http uri of git repo scanned'
+          # :dir_path => optional path to dir defaults to .
+          #{self}.scan(
+            dir_path: 'optional - dir path value consumed by #scan',
+            git_repo_root_uri: 'optional - git repo root uri value consumed by #scan'
           )
 
+          # Used primarily to map NIST 800-53 Revision 4 Security Controls
+          #{self}.security_references
+
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/sast/aws.rb

@@ -64,13 +64,19 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          sast_arr = #{self}.scan(
-            dir_path: 'optional path to dir defaults to .',
-            git_repo_root_uri: 'optional http uri of git repo scanned'
+          # Run scan and return its result
+          #{self}.scan(
+            dir_path: 'optional - optional path to dir defaults to .',
+            git_repo_root_uri: 'optional - optional http uri of git repo scanned'
           )
 
+          # Used primarily to map NIST 800-53 Revision 4 Security Controls
+          #{self}.security_references
+
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end