pwn 0.5.708 → 0.5.710

data/lib/pwn/sast/port.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/post_message.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/private_key.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/redirect.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/redos.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/shell.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/signature.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/sql.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'
+          # 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/ssl.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'
+          # 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/sudo.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/task_tag.rb

@@ -76,13 +76,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/test_case_engine.rb

@@ -169,17 +169,21 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          sast_arr = #{self}.execute(
-            test_case_filter: 'required grep command to filter results',
-            security_references: 'required Hash with keys :sast_module, :section, :nist_800_53_uri, :cwe_id, :cwe_uri',
-            dir_path: 'optional path to dir defaults to .',
-            include_extensions: 'optional array of file extensions to search for in scan (Defaults to all file types / i.e. [])',
-            exclude_extensions: 'optional array of file extensions to exclude from scan (Defaults to [.bin, .dat, .JS-BEAUTIFIED, .o, .test, .png, .jpg, .jpeg, .gif, .svg, .ico, .so, .spec, .zip, .tar, .gz, .tgz, .7z, .mp3, .mp4, .mov, .avi, .wmv, .flv, .mkv])',
-            git_repo_root_uri: 'optional http uri of git repo scanned'
+          # Run execute and return its result
+          #{self}.execute(
+            test_case_filter: 'required - grep command to filter results',
+            security_references: 'required - Hash with keys :sast_module, :section, :nist_800_53_uri, :cwe_id, :cwe_uri',
+            dir_path: 'optional - path to dir defaults to .',
+            include_extensions: 'optional - array of file extensions to search for in scan (Defaults to all file types / i.e. [])',
+            exclude_extensions: 'optional - array of file extensions to exclude from scan (Defaults to [.bin, .dat, .JS-BEAUTIFIED, .o, .test, .png, .jpg, .jpeg, .gif, .svg, .ico, .so, .spec, .zip, .tar, .gz, .tgz, .7z, .mp3, .mp4, .mov, .avi, .wmv, .flv, .mkv])',
+            git_repo_root_uri: 'optional - http uri of git repo scanned',
+            exclude_extentions: 'optional - exclude extentions value consumed by #execute'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/sast/throw_errors.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/token.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/type_script_type_juggling.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/use_after_free.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'
+          # :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/version.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/window_location_hash.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.rb

@@ -67,6 +67,10 @@ module PWN
     end
 
     public_class_method def self.help
+      puts "USAGE:
+        # Display a List of Every PWN::SAST Module
+        #{self}.authors
+      "
       constants.sort
     end
   end

data/lib/pwn/sdr/decoder/adsb.rb

@@ -252,18 +252,49 @@ module PWN
         # Display Usage for this Module
 
         public_class_method def self.help
-          puts "USAGE (true-air I/Q via PWN::FFI + detector fallback):
+          puts "USAGE:
+            # Run crc24 and return its result
+            #{self}.crc24(
+              bits: 'optional - bits value consumed by #crc24 (defaults to [])'
+            )
+
+            # Run crc ok and return its result
+            #{self}.crc_ok?(
+              bits: 'optional - bits value consumed by #crc_ok? (defaults to [])'
+            )
+
+            # Run decode modes and return its result
+            #{self}.decode_modes(
+              bits: 'optional - bits value consumed by #decode_modes (defaults to [])'
+            )
+
+            # Run ais char and return its result
+            #{self}.ais_char(
+              code: 'optional - code value consumed by #ais_char'
+            )
+
+            # Run modes altitude and return its result
+            #{self}.modes_altitude(
+              bits12: 'optional - bits12 value consumed by #modes_altitude'
+            )
+
+            # Run decode and return its result
             #{self}.decode(
               freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq',
-              source:   'optional - :auto|:rtlsdr|:adalm_pluto|:file',
-              file:     'optional - .cu8/.cs16 capture at ≥2 Msps'
+              sample_rate: 'optional - sample rate value consumed by #decode',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path'
             )
 
-            #{self}.decode_modes(bits: [0,1,...])   # 56/112 Mode-S bits
-            #{self}.parse_line(line: 'MSG,3,1,1,ABCDEF,1,...')
+            # Run parse line and return its result
+            #{self}.parse_line(
+              line: 'optional - line value consumed by #parse_line'
+            )
 
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
       end
     end

data/lib/pwn/sdr/decoder/apt.rb

@@ -132,17 +132,20 @@ module PWN
         # Display Usage for this Module
 
         public_class_method def self.help
-          puts "USAGE (ruby-native, no external binaries):
+          puts "USAGE:
+            # Run decode and return its result
             #{self}.decode(
-              freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq'
+              freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path',
+              out_path: 'optional - out path value consumed by #decode',
+              sample_rate: 'optional - sample rate value consumed by #decode'
             )
 
-            NOTE: Set GQRX to WFM (mono), ~34 kHz filter. Writes an 8-bit
-                  greyscale Netpbm P5 image to /tmp/apt_<ts>.pgm every 10 s
-                  of received pass. Both A/B channels are in one strip.
-
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
       end
     end