Gemfile && PWN::Plugins::Serial module - migrate deprecated serialport gem to uart gem :P

Author: ninp0

.rubocop_todo.yml

@@ -1,25 +1,14 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-10-30 18:35:44 UTC using RuboCop version 1.66.1.
+# on 2025-01-14 18:50:21 UTC using RuboCop version 1.70.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: space, no_space
-Layout/LineContinuationSpacing:
-  Exclude:
-    - 'packer/provisioners/beef.rb'
-    - 'packer/provisioners/metasploit.rb'
-    - 'packer/provisioners/wpscan.rb'
-    - 'vagrant/provisioners/beef.rb'
-
 # Offense count: 21
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Exclude:
@@ -41,7 +30,7 @@ Lint/NestedMethodDefinition:
   Exclude:
     - 'lib/pwn/plugins/repl.rb'
 
-# Offense count: 312
+# Offense count: 316
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AutoCorrect.
 Lint/UselessAssignment:
@@ -117,7 +106,7 @@ Style/Alias:
 Style/ClassVars:
   Enabled: false
 
-# Offense count: 282
+# Offense count: 280
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
 # SupportedStyles: assign_to_condition, assign_inside_condition
@@ -150,6 +139,21 @@ Style/MapIntoArray:
     - 'lib/pwn/plugins/credit_card.rb'
     - 'lib/pwn/plugins/nexpose_vuln_scan.rb'
 
+# Offense count: 9
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMethodComparison, ComparisonsThreshold.
+Style/MultipleComparison:
+  Exclude:
+    - 'lib/pwn/sast/banned_function_calls_c.rb'
+    - 'lib/pwn/sast/cmd_execution_python.rb'
+    - 'lib/pwn/sast/cmd_execution_ruby.rb'
+    - 'lib/pwn/sast/deserial_java.rb'
+    - 'lib/pwn/sast/factory.rb'
+    - 'lib/pwn/sast/logger.rb'
+    - 'lib/pwn/sast/throw_errors.rb'
+    - 'lib/pwn/www/duckduckgo.rb'
+    - 'lib/pwn/www/twitter.rb'
+
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 Style/RedundantBegin:

Gemfile

@@ -88,7 +88,7 @@ gem 'ruby-saml', '1.17.0'
 gem 'rvm', '1.11.3.9'
 gem 'savon', '2.15.1'
 gem 'selenium-devtools', '0.131.0'
-gem 'serialport', '1.3.2'
+# gem 'serialport', '1.3.2'
 # gem 'sinatra', '4.0.0'
 gem 'slack-ruby-client', '2.4.0'
 gem 'socksify', '1.7.1'
@@ -97,6 +97,7 @@ gem 'sqlite3', '2.5.0'
 gem 'thin', '1.8.2'
 gem 'tty-prompt', '0.23.1'
 gem 'tty-spinner', '0.9.3'
+gem 'uart', '1.0.0'
 gem 'watir', '7.3.0'
 gem 'waveform', '0.1.3'
 gem 'webrick', '1.9.1'

README.md

@@ -37,7 +37,7 @@ $ cd /opt/pwn
 $ ./install.sh
 $ ./install.sh ruby-gem
 $ pwn
-pwn[v0.5.228]:001 >>> PWN.help
+pwn[v0.5.229]:001 >>> PWN.help
 ```
 
 [![Installing the pwn Security Automation Framework](https://raw.githubusercontent.com/0dayInc/pwn/master/documentation/pwn_install.png)](https://youtu.be/G7iLUY4FzsI)
@@ -48,21 +48,21 @@ pwn[v0.5.228]:001 >>> PWN.help
 It's wise to update pwn often as numerous versions are released/week:
 ```
 $ rvm list gemsets
-$ rvm use ruby-3.3.5@pwn
+$ rvm use ruby-3.4.1@pwn
 $ gem uninstall --all --executables pwn
 $ gem install --verbose pwn
 $ pwn
-pwn[v0.5.228]:001 >>> PWN.help
+pwn[v0.5.229]:001 >>> PWN.help
 ```
 
 If you're using a multi-user install of RVM do:
 ```
 $ rvm list gemsets
-$ rvm use ruby-3.3.5@pwn
+$ rvm use ruby-3.4.1@pwn
 $ rvmsudo gem uninstall --all --executables pwn
 $ rvmsudo gem install --verbose pwn
 $ pwn
-pwn[v0.5.228]:001 >>> PWN.help
+pwn[v0.5.229]:001 >>> PWN.help
 ```
 
 PWN periodically upgrades to the latest version of Ruby which is reflected in `/opt/pwn/.ruby-version`.  The easiest way to upgrade to the latest version of Ruby from a previous PWN installation is to run the following script:

git_commit_test_reinit_gem.sh

@@ -12,7 +12,18 @@ if (( $# == 3 )); then
   git add . --all
   echo 'Updating Gems to Latest Versions in Gemfile...'
   ./find_latest_gem_versions_per_Gemfile.sh
+  if [[ $? -ne 0 ]]; then
+    echo 'ERROR: find_latest_gem_versions_per_Gemfile.sh failed!'
+    exit 1
+  fi
+
   pwn_autoinc_version
+  if [[ $? -ne 0 ]]; then
+    echo 'ERROR: pwn_autoinc_version failed! Investigate and bump pwn version manually.'
+    exit 1
+  fi
+
+  # Generate RDoc JSONL for fine-tunning LLMs
   pwn_rdoc_to_jsonl --rdoc-root-dir '/opt/pwn/rdoc/PWN' --jsonl-results '/opt/pwn/third_party/pwn_rdoc.jsonl'
 
   # Tag for every 100 commits (i.e. 0.1.100, 0.1.200, etc)
@@ -24,6 +35,10 @@ if (( $# == 3 )); then
 
   git commit -a -S --author="${1} <${2}>" -m "${3}"
   ./update_pwn.sh
+  if [[ $? -ne 0 ]]; then
+    echo 'ERROR: update_pwn.sh failed!'
+    exit 1
+  fi
 
   latest_gem=$(ls pkg/*.gem)
   if [[ $latest_gem != "" ]]; then

lib/pwn/plugins/bus_pirate.rb

@@ -127,8 +127,7 @@ module BusPirate
             baud: 'optional (defaults to 9600)',
             data_bits: 'optional (defaults to 8)',
             stop_bits: 'optional (defaults to 1)',
-            parity: 'optional (defaults to SerialPort::NONE)',
-            flow_control: 'optional (defaults to SerialPort::HARD) SerialPort::NONE|SerialPort::SOFT|SerialPort::HARD'
+            parity: 'optional - :even||:odd|:none (defaults to :none)'
           )
 
           #{self}.init_mode(

lib/pwn/plugins/msr206.rb

@@ -1169,8 +1169,7 @@ module MSR206
             baud: 'optional (defaults to 9600)',
             data_bits: 'optional (defaults to 8)',
             stop_bits: 'optional (defaults to 1)',
-            parity: 'optional - :even|:mark|:odd|:space|:none (defaults to :none),'
-            flow_control: 'optional - :none|:hard|:soft (defaults to :none)'
+            parity: 'optional - :even||:odd|:none (defaults to :none)'
           )
 
           cmds = #{self}.list_cmds

lib/pwn/plugins/serial.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'serialport'
+require 'uart'
 require 'io/wait'
 
 module PWN
@@ -16,63 +16,34 @@ module Serial
       #   baud: 'optional - (defaults to 9600)',
       #   data_bits: 'optional - (defaults to 8)',
       #   stop_bits: 'optional - (defaults to 1)',
-      #   parity: 'optional - :even|:mark|:odd|:space|:none (defaults to :none)',
-      #   flow_control: 'optional - :none||:hard||:soft (defaults to :none)'
+      #   parity: 'optional - :even|:mark|:odd|:space|:none (defaults to :none)'
       # )
 
       public_class_method def self.connect(opts = {})
-        block_dev = opts[:block_dev].to_s if File.exist?(
-          opts[:block_dev].to_s
-        )
-        block_dev = '/dev/ttyUSB0' if opts[:block_dev].nil?
-
-        baud = if opts[:baud].nil?
-                 9_600
-               else
-                 opts[:baud].to_i
-               end
-
-        data_bits = if opts[:data_bits].nil?
-                      8
-                    else
-                      opts[:data_bits].to_i
-                    end
-
-        stop_bits = if opts[:stop_bits].nil?
-                      1
-                    else
-                      opts[:stop_bits].to_i
-                    end
+        block_dev = opts[:block_dev] ||= '/dev/ttyUSB0'
+        raise "Invalid block device: #{block_dev}" unless File.exist?(block_dev)
+
+        baud = opts[:baud] ||= 9_600
+        data_bits = opts[:data_bits] ||= 8
+        stop_bits = opts[:stop_bits] ||= 1
 
+        parity = nil
         case opts[:parity].to_s.to_sym
         when :even
-          parity = SerialPort::EVEN
-        when :mark
-          parity = SerialPort::MARK
+          parity = 'E'
         when :odd
-          parity = SerialPort::ODD
-        when :space
-          parity = SerialPort::SPACE
-        else
-          parity = SerialPort::NONE
+          parity = 'O'
+        when :none
+          parity = 'N'
         end
+        raise "Invalid parity: #{opts[:parity]}" if parity.nil?
 
-        case opts[:flow_control].to_s.to_sym
-        when :hard
-          flow_control = SerialPort::HARD
-        when :soft
-          flow_control = SerialPort::SOFT
-        else
-          flow_control = SerialPort::NONE
-        end
+        mode = "#{data_bits}#{stop_bits}#{parity}"
 
-        serial_conn = SerialPort.new(
+        serial_conn = UART.open(
           block_dev,
           baud,
-          data_bits,
-          stop_bits,
-          parity,
-          flow_control
+          mode
         )
 
         serial_obj = {}
@@ -124,7 +95,9 @@ module Serial
       public_class_method def self.get_line_state(opts = {})
         serial_obj = opts[:serial_obj]
         serial_conn = serial_obj[:serial_conn]
-        serial_conn.get_signals
+        # Should return something like:
+        # {"rts"=>1, "dtr"=>1, "cts"=>1, "dsr"=>1, "dcd"=>0, "ri"=>0}
+        serial_conn.lstat
       rescue StandardError => e
         disconnect(serial_obj: serial_obj) unless serial_obj.nil?
         raise e
@@ -138,6 +111,8 @@ module Serial
       public_class_method def self.get_modem_params(opts = {})
         serial_obj = opts[:serial_obj]
         serial_conn = serial_obj[:serial_conn]
+        # Should return something like:
+        # {"baud"=>9600, "data_bits"=>8, "stop_bits"=>1, "parity"=>0}
         serial_conn.get_modem_params
       rescue StandardError => e
         disconnect(serial_obj: serial_obj) unless serial_obj.nil?
@@ -155,8 +130,10 @@ module Serial
         payload = opts[:payload]
         serial_conn = serial_obj[:serial_conn]
 
-        byte_arr = payload
+        byte_arr = nil
+        byte_arr = payload if payload.instance_of?(Array)
         byte_arr = payload.chars if payload.instance_of?(String)
+        raise "ERROR: Invalid payload type: #{payload.class}" if byte_arr.nil?
 
         byte_arr.each do |byte|
           serial_conn.putc(byte)
@@ -168,18 +145,6 @@ module Serial
         raise e
       end
 
-      # public_class_method def self.request(opts = {})
-      #   serial_obj = opts[:serial_obj]
-      #   request = opts[:request].to_s.scrub
-      #   serial_conn = serial_obj[:serial_conn]
-      #   chars_written = serial_conn.write(request)
-      #   serial_conn.flush
-      #   chars_written
-      # rescue StandardError => e
-      #   disconnect(serial_obj: serial_obj) unless serial_obj.nil?
-      #   raise e
-      # end
-
       # Supported Method Parameters::
       # PWN::Plugins::Serial.response(
       #   serial_obj: 'required - serial_obj returned from #connect method'
@@ -218,14 +183,6 @@ module Serial
         raise e
       end
 
-      # public_class_method def self.response(opts = {})
-      #   serial_obj = opts[:serial_obj]
-      #   @session_data.last
-      # rescue StandardError => e
-      #   disconnect(serial_obj: serial_obj) unless serial_obj.nil?
-      #   raise e
-      # end
-
       # Supported Method Parameters::
       # session_data = PWN::Plugins::Serial.dump_session_data
 
@@ -278,8 +235,7 @@ module Serial
             baud: 'optional (defaults to 9600)',
             data_bits: 'optional (defaults to 8)',
             stop_bits: 'optional (defaults to 1)',
-            parity: 'optional - :even|:mark|:odd|:space|:none (defaults to :none)',
-            flow_control: 'optional - :none||:hard||:soft (defaults to :none)'
+            parity: 'optional - :even|:mark|:odd|:space|:none (defaults to :none)'
           )
 
           line_state = #{self}.get_line_state(

lib/pwn/plugins/son_micro_rfid.rb

@@ -476,8 +476,7 @@ module SonMicroRFID
             baud: 'optional (defaults to 19_200)',
             data_bits: 'optional (defaults to 8)',
             stop_bits: 'optional (defaults to 1)',
-            parity: 'optional - :even|:mark|:odd|:space|:none (defaults to :odd),'
-            flow_control: 'optional - :none||:hard||:soft (defaults to :none)'
+            parity: 'optional - :even|:mark|:odd|:space|:none (defaults to :odd)'
           )
 
           cmds = #{self}.list_cmds

lib/pwn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PWN
-  VERSION = '0.5.228'
+  VERSION = '0.5.229'
 end

reinstall_pwn_gemset.sh

@@ -20,11 +20,11 @@ export rvmsudo_secure_path=1
 rvmsudo gem install bundler
 if [[ $(uname -s) == "Darwin" ]]; then
   bundle config build.pg --with-pg-config=/opt/local/lib/postgresql96/bin/pg_config
-  bundle config build.serialport \
-    --with-cflags=-Wno-implicit-function-declaration \
-    --with-cflags=-Wno-int-conversion
+  # bundle config build.serialport \
+  #   --with-cflags=-Wno-implicit-function-declaration \
+  #   --with-cflags=-Wno-int-conversion
 fi
-bundle config build.serialport --with-cflags=-Wno-int-conversion
+# bundle config build.serialport --with-cflags=-Wno-int-conversion
 bundle install
 # bundle install --full-index
 rvm --default ruby-$ruby_version@$ruby_gemset