packetgen 3.3.3 → 4.1.0

data/lib/packetgen/unknown_packet.rb

@@ -20,7 +20,7 @@ module PacketGen
 
     def initialize
       @headers = [].freeze
-      @binary_str = PacketGen.force_binary('')
+      @binary_str = ::String.new # Return empty string with encoding ASCII-8BIT, so BINARY
     end
 
     # Unknown packet, so unknown protocol.
@@ -30,7 +30,7 @@ module PacketGen
     end
 
     # Get packet body
-    # @return [Types]
+    # @return [String]
     def body
       @binary_str
     end
@@ -40,7 +40,7 @@ module PacketGen
     # @param [String] str
     # @return [void]
     def body=(str)
-      @binary_str = PacketGen.force_binary(str)
+      @binary_str = str.b
     end
 
     # Write packet to a PCapNG file on disk.
@@ -56,7 +56,7 @@ module PacketGen
     # @param [String] binary_str
     # @return [self]
     def parse(binary_str, _first_header: nil)
-      @binary_str = PacketGen.force_binary(binary_str)
+      @binary_str = binary_str.b
       self
     end
 
@@ -66,7 +66,7 @@ module PacketGen
       str << Inspect.inspect_body(body)
     end
 
-    # equality if {#to_s} is equal
+    # equality if {#to_s} are equal
     # @return [Boolean]
     def ==(other)
       to_s == other.to_s

data/lib/packetgen/utils/arp_spoofer.rb

@@ -22,15 +22,15 @@ module PacketGen
     # @author Sylvain Daubert
     # @since 2.1.3
     class ARPSpoofer
-      # @param [Integer,Float,nil] timeout spoof will happen for this amount
+      # @param [Numeric,nil] timeout spoof will happen for this amount
       #  of time
-      # @param [Integer,Float] interval time between 2 ARP packets
+      # @param [Numeric] interval time between 2 ARP packets
       # @param [String,nil] iface network interface on which do spoofing.
       #  Defaults to {PacketGen.default_iface}
       def initialize(timeout: nil, interval: 1.0, iface: nil)
         @timeout = timeout
         @timeout = @timeout.to_f if @timeout
-        @interval = interval
+        @interval = interval.to_f
         @iface = iface || PacketGen.default_iface
         @targets = {}
         @arp_packets = {}
@@ -56,19 +56,19 @@ module PacketGen
       # @param [String] target_ip target IP address
       # @return [void]
       def remove(target_ip)
-        @targets.delete target_ip
-        @arp_packets.delete target_ip
+        @targets.delete(target_ip)
+        @arp_packets.delete(target_ip)
       end
 
       # Get registered targets (all targets, registered with {#add} and {#start})
-      # @return [Array<String>] list of target IP addresses
+      # @return [Array<String>] list of registeres IP addresses
       def registered_targets
         @targets.keys
       end
 
       # Get active targets (registered with {#start}, or all after using
       # {#start_all})
-      # @return [Array<String>] list of target IP addresses
+      # @return [Array<String>] list of active IP addresses
       def active_targets
         @arp_packets.keys
       end
@@ -83,23 +83,23 @@ module PacketGen
       #  an ARP request is made to get it.
       # @return [void]
       def start(target_ip, spoofed_ip, options={})
-        add target_ip, spoofed_ip, options
-        activate target_ip
+        add(target_ip, spoofed_ip, options)
+        activate(target_ip)
       end
 
       # Stop spoofing on given target
       # @param [String] target_ip target IP address
       # @return [void]
       def stop(target_ip)
-        deactivate target_ip
-        remove target_ip
+        deactivate(target_ip)
+        remove(target_ip)
       end
 
       # Start spoofing on all targets added with {#add}.
       # @return [void]
       def start_all
         @targets.each_key do |target_ip|
-          activate target_ip
+          activate(target_ip)
         end
       end
 
@@ -107,7 +107,7 @@ module PacketGen
       # @return [void]
       def stop_all
         @targets.each_key do |target_ip|
-          deactivate target_ip
+          deactivate(target_ip)
         end
       end
 
@@ -115,9 +115,7 @@ module PacketGen
       # @param [String] target_ip target IP address
       # @return [Boolean]
       def active?(target_ip)
-        # rubocop:disable Style/ReturnNilInPredicateMethodDefinition
-        return unless @targets.key?(target_ip)
-        # rubocop:enable Style/ReturnNilInPredicateMethodDefinition
+        return false unless @targets.key?(target_ip)
 
         @targets[target_ip][:active]
       end
@@ -126,6 +124,7 @@ module PacketGen
       # was set on {#initialize}.
       def wait
         @spoof_thread.join
+        @spoof_thread = nil
       end
 
       private
@@ -143,7 +142,7 @@ module PacketGen
       # Create spoof thread
       def create_spoof_thread
         @spoof_thread = Thread.new(@queue, @timeout, @interval) do |queue, timeout, interval|
-          while timeout.nil? || timeout > 0.0
+          while timeout.nil? || timeout.positive?
             packets = queue.pop unless queue.empty?
             send_packets_on_wire(packets) unless packets.empty?
             timeout -= interval if timeout
@@ -161,9 +160,9 @@ module PacketGen
       # @param [String] target_ip
       # @return [void]
       def deactivate(target_ip)
-        @arp_packets.delete target_ip
+        @arp_packets.delete(target_ip)
         if @arp_packets.empty?
-          @spoof_thread.kill
+          @spoof_thread&.kill
           @spoof_thread = nil
         else
           @queue << @arp_packets.values

data/lib/packetgen/utils.rb

@@ -31,9 +31,9 @@ module PacketGen
     # @private
     IP_PATH = '/usr/bin/ip'
     # @private
-    ARP_LINE_RE = /\((\d+\.\d+\.\d+\.\d+)\) at (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})(?: \[ether\])? on (\w+)/.freeze
+    ARP_LINE_RE = /\((\d+\.\d+\.\d+\.\d+)\) at (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})(?: \[ether\])? on (\w+)/
     # @private
-    IP_LINE_RE = /^(\d+\.\d+\.\d+\.\d+) dev (\w+) lladdr (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})/.freeze
+    IP_LINE_RE = /^(\d+\.\d+\.\d+\.\d+) dev (\w+) lladdr (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})/
 
     # Get local ARP cache
     # @return [Hash] key: IP address, value: array containing MAC address and
@@ -168,7 +168,8 @@ module PacketGen
     def self.mitm(target1, target2, options={}, &block)
       options = { iface: PacketGen.default_iface }.merge(options)
 
-      spoofer = Utils::ARPSpoofer.new(options)
+      spoofer_options = options.slice(:timeout, :interval, :iface)
+      spoofer = Utils::ARPSpoofer.new(**spoofer_options.compact)
       spoofer.add target1, target2, options
       spoofer.add target2, target1, options
 

data/lib/packetgen/version.rb

@@ -11,5 +11,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '3.3.3'
+  VERSION = '4.1.0'
 end

data/lib/packetgen.rb

@@ -8,10 +8,12 @@
 # This program is published under MIT license.
 
 require 'packetgen/version'
+require 'bin_struct'
 require 'interfacez'
 
 # PacketGen is a network packet generator and analyzor.
 # @author Sylvain Daubert
+# @author LemonTree
 module PacketGen
   # Base exception class for PacketGen exceptions
   class Error < StandardError; end
@@ -32,12 +34,15 @@ module PacketGen
     # @return [Headerable]
     attr_reader :hdr
 
+    # @param [Headerable] prev_hdr
+    # @param [Headerable] hdr
     def initialize(prev_hdr, hdr)
       super()
       @prev_hdr = prev_hdr
       @hdr = hdr
     end
 
+    # @return [String]
     def message
       "#{prev_hdr.class} knowns no layer association with #{hdr.protocol_name}. " \
         "Try #{prev_hdr.class}.bind_layer(#{hdr.class}, " \
@@ -91,8 +96,10 @@ module PacketGen
   # Force binary encoding for +str+
   # @param [String] str
   # @return [String] binary encoded string
+  # @deprecated Use +String#b+ instead.
   def self.force_binary(str)
-    str.dup.force_encoding(Encoding::BINARY)
+    Deprecation.deprecated(self, :force_binary, 'String#b')
+    str.b
   end
 
   # Get default network interface (ie. first non-loopback declared interface)
@@ -100,12 +107,13 @@ module PacketGen
   def self.default_iface
     return @default_iface if defined? @default_iface
 
-    @default_iface = Interfacez.raw_interface_addresses.each do |iface|
+    Interfacez.raw_interface_addresses.each do |iface|
       next unless iface.broadaddr
       next unless Interfacez.ipv4_address_of(iface.name)
       next unless Interfacez.ipv6_address_of(iface.name)
 
-      break iface.name
+      @default_iface = iface.name
+      break
     end
   end
 
@@ -118,7 +126,7 @@ module PacketGen
   # Shortcut to get a header class
   # @example builtin class
   #   # same as PacketGen::Header::Dot11:Data.new(id: 0xfedc)
-  #   dot11 = PacketGen.header('Dot11::Data', id: 0xfedc)  #=> PacketGen::Header::Dot11:Data
+  #   dot11 = PacketGen.header('Dot11::Data', id: 0xfedc)
   # @example plugin class
   #   require 'packet-plugin-smb'
   #   # same as PacketGen::Plugin::SMB::CloseRequest.new(fid: 0x1234)
@@ -133,7 +141,6 @@ end
 
 require 'packetgen/deprecation'
 require 'packetgen/inspect'
-require 'packetgen/types'
 require 'packetgen/pcapng'
 require 'packetgen/pcap'
 require 'packetgen/packet'

metadata

@@ -1,77 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 4.1.0
 platform: ruby
 authors:
 - LemonTree55
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2025-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: interfacez
+  name: bin_struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: pcaprub
+  name: digest-crc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rasn1
+  name: interfacez
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pcaprub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
-  name: digest-crc
+  name: rasn1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
 description: |
   PacketGen is a network packet manipulation library. It allows reading, parsing
   and sending network packets with fun.
@@ -197,24 +204,10 @@ files:
 - lib/packetgen/pcapng/unknown_block.rb
 - lib/packetgen/pcaprub_wrapper.rb
 - lib/packetgen/proto.rb
-- lib/packetgen/types.rb
-- lib/packetgen/types/abstract_tlv.rb
-- lib/packetgen/types/array.rb
-- lib/packetgen/types/cstring.rb
-- lib/packetgen/types/enum.rb
-- lib/packetgen/types/fieldable.rb
-- lib/packetgen/types/fields.rb
-- lib/packetgen/types/int.rb
-- lib/packetgen/types/int_string.rb
-- lib/packetgen/types/length_from.rb
-- lib/packetgen/types/oui.rb
-- lib/packetgen/types/string.rb
-- lib/packetgen/types/tlv.rb
 - lib/packetgen/unknown_packet.rb
 - lib/packetgen/utils.rb
 - lib/packetgen/utils/arp_spoofer.rb
 - lib/packetgen/version.rb
-homepage:
 licenses:
 - MIT
 metadata:
@@ -223,7 +216,6 @@ metadata:
   bug_tracker_uri: https://github.com/lemontree55/packetgen/issues
   documentation_uri: https://www.rubydoc.info/gems/packetgen
   wiki_uri: https://github.com/lemontree55/packetgen/wiki
-post_install_message:
 rdoc_options:
 - "--title"
 - PacketGen - network packet dissector
@@ -237,15 +229,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Network packet generator and dissector
 test_files: []