packetgen 3.3.2 → 4.0.0

data/lib/packetgen/pcapng/idb.rb

@@ -36,18 +36,18 @@ module PacketGen
       # @!attribute link_type
       #  16-bit link type
       #  @return [Integer]
-      define_field_before :block_len2, :link_type, Types::Int16, default: 1
+      define_attr_before :block_len2, :link_type, BinStruct::Int16, default: 1
       # @!attribute reserved
       #  16-bit reserved field
       #  @return [Integer]
-      define_field_before :block_len2, :reserved, Types::Int16, default: 0
+      define_attr_before :block_len2, :reserved, BinStruct::Int16, default: 0
       # @!attribute snaplen
       #  32-bit snap length
       #  @return [Integer]
-      define_field_before :block_len2, :snaplen, Types::Int32, default: 0
+      define_attr_before :block_len2, :snaplen, BinStruct::Int32, default: 0
       # @!attribute options
-      #  @return [Types::String]
-      define_field_before :block_len2, :options, Types::String
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :options, BinStruct::String
 
       # @param [Hash] options
       # @option options [:little, :big] :endian set block endianness
@@ -61,10 +61,8 @@ module PacketGen
       # @option options [Integer] :block_len2 block total length
       def initialize(options={})
         super
-        endianness(options[:endian] || :little)
         @packets = []
         @options_decoded = false
-        recalc_block_len
         self.type = options[:type] || PcapNG::IDB_TYPE.to_i
       end
 
@@ -76,9 +74,9 @@ module PacketGen
         return self if io.eof?
 
         %i[type block_len link_type reserved snaplen].each do |attr|
-          self[attr].read io.read(self[attr].sz)
+          self[attr].read(io.read(self[attr].sz))
         end
-        self[:options].read io.read(self.block_len - MIN_SIZE)
+        self[:options].read(io.read(self.block_len - MIN_SIZE))
         read_blocklen2_and_check(io)
 
         self
@@ -107,7 +105,7 @@ module PacketGen
       # Return the object as a String
       # @return [String]
       def to_s
-        pad_field :options
+        pad_field(:options)
         recalc_block_len
         super << @packets.map(&:to_s).join
       end
@@ -119,7 +117,7 @@ module PacketGen
         @options_decoded = true
         return @ts_resol = 1E-6 if tsresol.nil?
 
-        @ts_resol = if (tsresol & 0x80).zero?
+        @ts_resol = if tsresol.nobits?(0x80)
                       10**-tsresol
                     else
                       2**-(tsresol & 0x7f)

data/lib/packetgen/pcapng/shb.rb

@@ -45,23 +45,23 @@ module PacketGen
       # @!attribute magic
       #  32-bit magic number
       #  @return [Integer]
-      define_field_before :block_len2, :magic, Types::Int32, default: MAGIC_INT32
+      define_attr_before :block_len2, :magic, BinStruct::Int32, default: MAGIC_INT32
       # @!attribute ver_major
       #  16-bit major version number
       #  @return [Integer]
-      define_field_before :block_len2, :ver_major, Types::Int16, default: 1
+      define_attr_before :block_len2, :ver_major, BinStruct::Int16, default: 1
       # @!attribute ver_major
       #  16-bit minor version number
       #  @return [Integer]
-      define_field_before :block_len2, :ver_minor, Types::Int16, default: 0
+      define_attr_before :block_len2, :ver_minor, BinStruct::Int16, default: 0
       # @!attribute section_len
       #  64-bit section length
       #  @return [Integer]
-      define_field_before :block_len2, :section_len, Types::Int64,
-                          default: SECTION_LEN_UNDEFINED
+      define_attr_before :block_len2, :section_len, BinStruct::Int64,
+                         default: SECTION_LEN_UNDEFINED
       # @!attribute options
-      #  @return [Types::String]
-      define_field_before :block_len2, :options, Types::String
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :options, BinStruct::String
 
       # @param [Hash] options
       # @option options [:little, :big] :endian set block endianness
@@ -81,8 +81,6 @@ module PacketGen
         super
         @interfaces = []
         @unknown_blocks = []
-        endianness(options[:endian] || :little)
-        recalc_block_len
         self.type = options[:type] || PcapNG::SHB_TYPE.to_i
       end
 
@@ -93,9 +91,9 @@ module PacketGen
         io = to_io(str_or_io)
         return self if io.eof?
 
-        self[:type].read check_shb(io)
+        self[:type].read(check_shb(io))
         %i[block_len magic ver_major ver_minor section_len].each do |attr|
-          self[attr].read io.read(self[attr].sz)
+          self[attr].read(io.read(self[attr].sz))
         end
         handle_magic_and_check(self[:magic].to_s)
 
@@ -120,7 +118,7 @@ module PacketGen
         body = @interfaces.map(&:to_s).join
         self.section_len = body.size unless self.section_len == SECTION_LEN_UNDEFINED
 
-        pad_field :options
+        pad_field(:options)
         recalc_block_len
         super + body
       end
@@ -135,12 +133,12 @@ module PacketGen
       def force_endianness(endian)
         @endian = endian
         %i[type block_len magic block_len2].each do |attr|
-          self[attr] = Types::Int32.new(0, endian).read(self[attr].to_s)
+          self[attr] = BinStruct::Int32.new(value: 0, endian: endian).read(self[attr].to_s)
         end
         %i[ver_major ver_minor].each do |attr|
-          self[attr] = Types::Int16.new(0, endian).read(self[attr].to_s)
+          self[attr] = BinStruct::Int16.new(value: 0, endian: endian).read(self[attr].to_s)
         end
-        self[:section_len] = Types::Int64.new(0, endian).read(self[:section_len].to_s)
+        self[:section_len] = BinStruct::Int64.new(value: 0, endian: endian).read(self[:section_len].to_s)
       end
 
       # Check io contains a SHB

data/lib/packetgen/pcapng/spb.rb

@@ -29,10 +29,10 @@ module PacketGen
       # @!attribute orig_len
       #  32-bit original length
       #  @return [Integer]
-      define_field_before :block_len2, :orig_len, Types::Int32, default: 0
+      define_attr_before :block_len2, :orig_len, BinStruct::Int32, default: 0
       # @!attribute data
-      #  @return [Types::String]
-      define_field_before :block_len2, :data, Types::String
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :data, BinStruct::String
 
       # @param [Hash] options
       # @option options [:little, :big] :endian set block endianness
@@ -45,8 +45,6 @@ module PacketGen
       # @option options [Integer] :block_len2 block total length
       def initialize(options={})
         super
-        endianness(options[:endian] || :little)
-        recalc_block_len
         self.type = options[:type] || PcapNG::SPB_TYPE.to_i
       end
 
@@ -64,11 +62,11 @@ module PacketGen
         io = to_io(str_or_io)
         return self if io.eof?
 
-        self[:type].read io.read(4)
-        self[:block_len].read io.read(4)
-        self[:orig_len].read io.read(4)
+        self[:type].read(io.read(4))
+        self[:block_len].read(io.read(4))
+        self[:orig_len].read(io.read(4))
         data_len = compute_data_len
-        self[:data].read io.read(data_len)
+        self[:data].read(io.read(data_len))
         remove_padding(io, data_len)
         read_blocklen2_and_check(io)
 
@@ -79,7 +77,7 @@ module PacketGen
       # Return the object as a String
       # @return [String]
       def to_s
-        pad_field :data
+        pad_field(:data)
         recalc_block_len
         super
       end

data/lib/packetgen/pcapng/unknown_block.rb

@@ -20,19 +20,8 @@ module PacketGen
       attr_accessor :section
 
       # @!attribute body
-      #  @return [Types::String]
-      define_field_before :block_len2, :body, Types::String
-
-      # @option options [:little, :big] :endian set block endianness
-      # @option options [Integer] :type
-      # @option options [Integer] :block_len block total length
-      # @option options [::String] :body
-      # @option options [Integer] :block_len2 block total length
-      def initialize(options={})
-        super
-        endianness(options[:endian] || :little)
-        recalc_block_len
-      end
+      #  @return [BinStruct::String]
+      define_attr_before :block_len2, :body, BinStruct::String
 
       # Has this block options?
       # @return [false]
@@ -48,9 +37,9 @@ module PacketGen
         io = to_io(str_or_io)
         return self if io.eof?
 
-        self[:type].read io.read(4)
-        self[:block_len].read io.read(4)
-        self[:body].read io.read(self[:block_len].to_i - MIN_SIZE)
+        self[:type].read(io.read(4))
+        self[:block_len].read(io.read(4))
+        self[:body].read(io.read(self[:block_len].to_i - MIN_SIZE))
         read_blocklen2_and_check(io)
 
         self
@@ -59,7 +48,7 @@ module PacketGen
       # Return the object as a String
       # @return [String]
       def to_s
-        pad_field :body
+        pad_field(:body)
         recalc_block_len
         super
       end

data/lib/packetgen/pcapng.rb

@@ -14,13 +14,13 @@ module PacketGen
   # @author Sylvain Daubert
   module PcapNG
     # Section Header Block type number
-    SHB_TYPE = Types::Int32.new(0x0A0D0D0A, :little).freeze
+    SHB_TYPE = BinStruct::Int32.new(value: 0x0A0D0D0A, endian: :little).freeze
     # Interface Description Block type number
-    IDB_TYPE = Types::Int32.new(1, :little).freeze
+    IDB_TYPE = BinStruct::Int32.new(value: 1, endian: :little).freeze
     # Simple Packet Block type number
-    SPB_TYPE = Types::Int32.new(3, :little).freeze
+    SPB_TYPE = BinStruct::Int32.new(value: 3, endian: :little).freeze
     # Enhanced Packet Block type number
-    EPB_TYPE = Types::Int32.new(6, :little).freeze
+    EPB_TYPE = BinStruct::Int32.new(value: 6, endian: :little).freeze
 
     # IEEE 802.3 Ethernet (10Mb, 100Mb, 1000Mb, and up)
     LINKTYPE_ETHERNET = 1

data/lib/packetgen/pcaprub_wrapper.rb

@@ -10,6 +10,7 @@ require 'pcaprub'
 module PacketGen
   # Wrapper around PCAPRUB
   # @author Sylvain Daubert
+  # @author LemonTree55
   # @api private
   # @since 3.1.4
   module PCAPRUBWrapper
@@ -35,8 +36,9 @@ module PacketGen
       pcap.setpromisc(promisc)
       pcap.settimeout(TIMEOUT)
       # Monitor MUST be set before pcap is activated
-      pcap.setmonitor monitor unless monitor.nil?
+      pcap.setmonitor(monitor) unless monitor.nil?
       pcap.activate
+      pcap
     end
 
     # Capture packets from a network interface
@@ -74,5 +76,19 @@ module PacketGen
     def self.read_pcap(filename:, &block)
       PCAPRUB::Pcap.open_offline(filename).each_packet(&block)
     end
+
+    # Write binary packets to a PCAP file
+    # @param [String] filename
+    # @param [Array<String>] packets
+    # @return [void]
+    # @since 4.0.0
+    # @author LemonTree55
+    def self.write_pcap(filename:, packets:)
+      PCAPRUB::Pcap.dump_open(filename) do |pcap|
+        packets.each do |packet|
+          pcap.dump(packet)
+        end
+      end
+    end
   end
 end

data/lib/packetgen/proto.rb

@@ -10,7 +10,7 @@
 require 'socket'
 
 module PacketGen
-  # Module handling some helper methods for protocols
+  # Module handling some helper methods for well_known protocols
   # @author Sylvain Daubert
   # @since 2.1.2
   module Proto

data/lib/packetgen/unknown_packet.rb

@@ -30,7 +30,7 @@ module PacketGen
     end
 
     # Get packet body
-    # @return [Types]
+    # @return [String]
     def body
       @binary_str
     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

data/lib/packetgen/version.rb

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

data/lib/packetgen.rb

@@ -8,6 +8,7 @@
 # This program is published under MIT license.
 
 require 'packetgen/version'
+require 'bin_struct'
 require 'interfacez'
 
 # PacketGen is a network packet generator and analyzor.
@@ -100,12 +101,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
 
@@ -133,7 +135,6 @@ end
 
 require 'packetgen/deprecation'
 require 'packetgen/inspect'
-require 'packetgen/types'
 require 'packetgen/pcapng'
 require 'packetgen/pcap'
 require 'packetgen/packet'

metadata

@@ -1,15 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 4.0.0
 platform: ruby
 authors:
 - LemonTree55
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-13 00:00:00.000000000 Z
+date: 2024-12-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bin_struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: digest-crc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: interfacez
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.14'
 description: |
   PacketGen is a network packet manipulation library. It allows reading, parsing
   and sending network packets with fun.
@@ -183,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:
@@ -209,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
@@ -223,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: []