pwn 0.5.708 → 0.5.709

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

data/lib/pwn/sast/banned_function_calls_c.rb

@@ -194,13 +194,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/base64.rb

@@ -61,13 +61,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 to dictate Security Control Requirements for a Given SAST module
+          #{self}.security_references
+
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/sast/beef_hook.rb

@@ -62,13 +62,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/cmd_execution_go_lang.rb

@@ -70,13 +70,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/cmd_execution_java.rb

@@ -67,13 +67,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/cmd_execution_python.rb

@@ -69,13 +69,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/cmd_execution_ruby.rb

@@ -77,13 +77,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/cmd_execution_scala.rb

@@ -67,13 +67,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/csrf.rb

@@ -61,13 +61,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/deserial_java.rb

@@ -72,13 +72,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/emoticon.rb

@@ -69,13 +69,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/eval.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'
+          # 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/factory.rb

@@ -66,13 +66,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/http_authorization_header.rb

@@ -67,13 +67,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