pwn 0.5.708 → 0.5.709

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

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

@@ -626,38 +626,90 @@ module PWN
         # Display Usage for this Module
 
         public_class_method def self.help
-          puts "USAGE (100 % ruby-native — no external binaries):
+          puts "USAGE:
+            # Run run native and return its result
             #{self}.run_native(
-              freq_obj: 'required - freq_obj from PWN::SDR::GQRX.init_freq',
-              protocol: 'required - short protocol name',
-              demod:    'required - object with #feed(samples,&emit)',
-              rate:     'optional - UDP sample rate (default 48000)'
+              freq_obj: 'required - freq_obj Hash from PWN::SDR::GQRX.init_freq',
+              protocol: 'required - short name for banner / log filename (defaults to SIGNAL)',
+              demod: 'required - object responding to #feed(samples,&emit)',
+              rate: 'optional - assumed UDP sample rate (default 48000)'
             )
 
-            #{self}.run_iq(
-              freq_obj:    'required - freq_obj Hash',
-              protocol:    'required - short protocol name',
-              demod:       'required - #feed_iq(iq, rate:, &emit) or #feed',
-              sample_rate: 'optional - Hz (default 2_048_000)',
-              source:      'optional - :auto|:rtlsdr|:hackrf|:adalm_pluto|:soapy|:file',
-              file:        'optional - .cu8/.cs16 capture path',
-              fm_demod:    'optional - FM-demod then #feed (default false)',
-              fallback:    'optional - :detector|:raise|:silent (default :detector)'
+            # Run run detector and return its result
+            #{self}.run_detector(
+              freq_obj: 'required - freq_obj Hash from PWN::SDR::GQRX.init_freq',
+              protocol: 'required - short name for banner / log filename (defaults to SIGNAL)',
+              note: 'optional - one-line explanation shown once',
+              threshold: 'optional - dBFS above rolling floor to call a burst (default 8.0)',
+              describe: 'optional - Proc.new { |burst_hash| Hash } extra fields'
             )
 
-            #{self}.run_detector(
-              freq_obj:  'required - freq_obj from PWN::SDR::GQRX.init_freq',
-              protocol:  'required - short protocol name',
-              note:      'optional - explanation shown to operator',
-              threshold: 'optional - dB above floor for burst (default 8.0)',
-              describe:  'optional - Proc { |burst| Hash } extra fields'
+            # Run match line and return its result
+            #{self}.match_line?(
+              line: 'optional - line value consumed by #match_line?',
+              matcher: 'optional - matcher value consumed by #match_line?'
+            )
+
+            # Run resolve iq source and return its result
+            #{self}.resolve_iq_source(
+              freq_obj: 'required - freq obj value consumed by #resolve_iq_source',
+              source: 'optional - :auto|:rtlsdr|:hackrf|:adalm_pluto|:soapy|:file',
+              sample_rate: 'optional - desired rate Hz',
+              file: 'optional - path to .cu8/.cs16/.iq capture (defaults to freq_obj[:iq_file])',
+              iq_format: 'optional - iq format value consumed by #resolve_iq_source (defaults to freq_obj[:iq_format])',
+              index: 'optional - index value consumed by #resolve_iq_source',
+              gain_db: 'optional - gain db value consumed by #resolve_iq_source (defaults to freq_obj[:gain_db])',
+              ppm: 'optional - ppm value consumed by #resolve_iq_source',
+              serial: 'optional - serial value consumed by #resolve_iq_source',
+              lna_gain: 'optional - lna gain value consumed by #resolve_iq_source (defaults to 16)',
+              vga_gain: 'optional - vga gain value consumed by #resolve_iq_source (defaults to 20)',
+              amp: 'optional - amp value consumed by #resolve_iq_source',
+              uri: 'optional - URI or URL string',
+              chunk_samples: 'optional - chunk samples value consumed by #resolve_iq_source',
+              soapy_args: 'optional - soapy args value consumed by #resolve_iq_source (defaults to freq_obj[:soapy_args])',
+              channel: 'optional - channel value consumed by #resolve_iq_source (defaults to 0)'
+            )
+
+            # Run read iq chunk and return its result
+            #{self}.read_iq_chunk(
+              source: 'required - source value consumed by #read_iq_chunk',
+              bytes: 'optional - bytes value consumed by #read_iq_chunk'
             )
 
-            #{self}.resolve_iq_source(freq_obj:, source: :auto, sample_rate:, file:)
-            #{self}.match_line?(line: str, matcher: Regexp|String|Array)
+            # Run unpack iq and return its result
+            #{self}.unpack_iq(
+              source: 'optional - source value consumed by #unpack_iq',
+              data: 'optional - data value consumed by #unpack_iq'
+            )
+
+            # Run close iq source and return its result
+            #{self}.close_iq_source(
+              source: 'optional - source value consumed by #close_iq_source'
+            )
+
+            # OR #feed(samples, &emit) when fm_demod:true,
+            #{self}.run_iq(
+              freq_obj: 'required - freq_obj Hash',
+              protocol: 'required - short name (defaults to SIGNAL)',
+              demod: 'required - object with #feed_iq(iq, rate:, &emit',
+              sample_rate: 'optional - Hz (default 2_048_000)',
+              source: 'optional - :auto|:rtlsdr|:hackrf|:adalm_pluto|:soapy|:file',
+              file: 'optional - path to capture',
+              fm_demod: 'optional - FM-demod I/Q→audio then #feed (default false)',
+              chunk_bytes: 'optional - bytes per read (default 262144)',
+              fallback: 'optional - :detector|:raise|:silent (default :detector)',
+              note: 'optional - shown once when falling back',
+              describe: 'optional - Proc for detector fallback',
+              gain_db: 'optional - gain db value consumed by #run_iq',
+              uri: 'optional - URI or URL string',
+              index: 'optional - index value consumed by #run_iq',
+              threshold: 'optional - threshold value consumed by #run_iq'
+            )
 
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
       end
     end

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

@@ -191,18 +191,30 @@ module PWN
         end
 
         public_class_method def self.help
-          puts "USAGE (true-air I/Q via PWN::FFI + detector fallback):
+          puts "USAGE:
+            # Run ble crc24 and return its result
+            #{self}.ble_crc24(
+              bytes: 'optional - bytes value consumed by #ble_crc24 (defaults to [])'
+            )
+
+            # 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 (≥2 Msps)',
-              channel:  'optional - BLE adv channel 37|38|39 (default nearest to freq)'
+              channel: 'optional - channel value consumed by #decode',
+              sample_rate: 'optional - sample rate value consumed by #decode',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path'
             )
 
-            #{self}.ble_crc24(bytes: [..])
+            # 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/dect.rb

@@ -138,15 +138,24 @@ module PWN
         end
 
         public_class_method def self.help
-          puts "USAGE (true-air I/Q via PWN::FFI + detector fallback):
+          puts "USAGE:
+            # 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 (≥2.304 Msps)'
+              sample_rate: 'optional - sample rate value consumed by #decode',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path'
             )
 
+            # 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