packetgen 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad942df146df9daf8c38e049fc112b13c93fd38a45362e8dd2a43c6e8382b224
-  data.tar.gz: 77b48a6af0170a912e91b888456c31881bfe1fd30a693796c849a946b5e27bac
+  metadata.gz: de85a6f18ac001823cdbd0802c8946ead811be724c9069266b78c493d99feb6b
+  data.tar.gz: ef73ca367e87bb47ca4f37ee387c7a73d0ad0f19cebaca151443560f42508559
 SHA512:
-  metadata.gz: 98f7f9d7dd652741cdce08cbe081310c4f4ca6745702efc5755806614f30c7930498610f9925a6d7abeef1b8b64abfa2857c77bcc638872f31577fe587ad1e63
-  data.tar.gz: cc4e18519b09f7eaa753f9f2e4a500c5b3d0de2aed5bbd275b636d5c21ec763dca2a34da27a16336d65e2ec86d827812c0f546c5e67dfd9b500d683f8baac7ac
+  metadata.gz: '01605812af7b7d53111bfdc0d4d095cb6f0df4975634db17700d7c15c6acc63ba82585e6c5a5d2d93c130d566f45bb62d9ff3709c27e0f7cf4ea0c20ba7c172f'
+  data.tar.gz: e4a54c74e032ee12d744f94c657416591c0f056a005da4b104c017294d73819596a28ec59c71597f8d0f2398da79a8b7784809d5e30cd5da9d53fc655101e2f4

data/lib/packetgen/capture.rb

@@ -27,6 +27,11 @@ module PacketGen
     # @return [Array<String>]
     attr_reader :raw_packets
 
+    # Get timestamps associated with {#packets} and {#raw_packets}
+    # @return [Array<Time>]
+    # @since 3.3.0
+    attr_reader :timestamps
+
     # Get interface name
     # @return [String]
     attr_reader :iface
@@ -54,6 +59,7 @@ module PacketGen
 
       @packets     = []
       @raw_packets = []
+      @timestamps = []
       set_options iface, max, timeout, filter, promisc, parse, snaplen, monitor
     end
 
@@ -61,16 +67,18 @@ module PacketGen
     # @see {#initialize} for parameters
     # @yieldparam [Packet,String] packet if a block is given, yield each
     #    captured packet (Packet or raw data String, depending on +:parse+ option)
+    # @yieldparam [Time] timestamp packet timestamp
     # @since 3.0.0 arguments are kwargs and no more a hash
     # @since 3.1.5 add monitor argument
+    # @since 3.3.0 add packet timestamp as second yield parameter
     # @author Sylvain Daubert
     # @author optix2000 - add monitor argument
     def start(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: nil, monitor: nil, &block)
       set_options iface, max, timeout, filter, promisc, parse, snaplen, monitor
 
       @cap_thread = Thread.new do
-        PCAPRUBWrapper.capture(**capture_args) do |packet_data|
-          add_packet(packet_data, &block)
+        PCAPRUBWrapper.capture(**capture_args) do |packet|
+          add_packet(packet, &block)
           break if defined?(@max) && (raw_packets.size >= @max)
         end
       end
@@ -119,18 +127,21 @@ module PacketGen
       PCAPRUBWrapper.filter_on(pcap: pcap, filter: filter)
     end
 
-    def add_packet(data, &block)
-      raw_packets << data
+    def add_packet(packet, &block)
+      raw_packets << packet.data
+      ts = Time.at(packet.time, packet.microsec.to_r, :usec)
+      timestamps << ts
+
       if @parse
         begin
-          packet = Packet.parse(data)
+          packet = Packet.parse(packet.data)
         rescue ParseError
-          packet = UnknownPacket.new.parse(data)
+          packet = UnknownPacket.new.parse(packet.data)
         end
         packets << packet
-        block&.call(packet)
+        block&.call(packet, ts)
       elsif block
-        yield data
+        yield data, ts
       end
     end
   end

data/lib/packetgen/header/dns/name.rb

@@ -67,9 +67,9 @@ module PacketGen
               @pointer = str[start, 2]
               break
             else
-              label = add_label_from(str[start..-1])
+              label = add_label_from(str[start..])
               start += label.sz
-              break if label.length.zero? || str[start..-1].length.zero?
+              break if label.empty? || str[start..].empty?
             end
           end
           # force resolution of compressed names
@@ -110,7 +110,7 @@ module PacketGen
           ptr = index & mask
           name = Name.new
           name.dns = @dns
-          @pointer_name = name.read(self.dns.to_s[ptr..-1]).to_human
+          @pointer_name = name.read(self.dns.to_s[ptr..]).to_human
         end
 
         def record_from_hash(_hsh)

data/lib/packetgen/header/dns/rr.rb

@@ -108,7 +108,7 @@ module PacketGen
           name.dns = self[:name].dns
 
           pref = Types::Int16.new.read(self[:rdata][0, 2])
-          exchange = name.read(self[:rdata][2..-1]).to_human
+          exchange = name.read(self[:rdata][2..]).to_human
 
           '%u %s' % [pref.to_i, exchange]
         end
@@ -118,7 +118,7 @@ module PacketGen
           name = Name.new
           name.dns = self[:name].dns
           mname = name.read(self[:rdata]).dup
-          rname = name.read(self[:rdata][mname.sz..-1])
+          rname = name.read(self[:rdata][mname.sz..])
 
           serial = Types::Int32.new.read(self[:rdata][mname.sz + rname.sz, 4])
           refresh = Types::Int32.new.read(self[:rdata][mname.sz + rname.sz + 4, 4])

data/lib/packetgen/header/dot11.rb

@@ -403,7 +403,7 @@ module PacketGen
         define_applicable_fields
         if fcs
           old_read str[0...-4]
-          self[:fcs].read str[-4..-1]
+          self[:fcs].read str[-4..]
         else
           old_read str
         end

data/lib/packetgen/header/http/request.rb

@@ -107,7 +107,7 @@ module PacketGen
 
         def headers_and_payload_from_lines(lines)
           if (data_index = lines.find_index(''))
-            data    = lines[data_index + 1..-1].join("\n")
+            data    = lines[data_index + 1..].join("\n")
             headers = lines[0..data_index - 1].join("\n")
           else
             headers = lines.join("\n")

data/lib/packetgen/header/http/response.rb

@@ -126,7 +126,7 @@ module PacketGen
 
           self[:version].read first_line[0]
           self[:status_code].read first_line[1]
-          self[:status_mesg].read first_line[2..-1].join(' ')
+          self[:status_mesg].read first_line[2..].join(' ')
         end
 
         def raise_on_bad_version_status

data/lib/packetgen/header/ip/option.rb

@@ -18,7 +18,7 @@ module PacketGen
         # @return [self]
         #   array << '192.168.1.12'
         def push(addr)
-          addr = addr.is_a?(Addr) ? addr : Addr.new.from_human(addr)
+          addr = Addr.new.from_human(addr) unless addr.is_a?(Addr)
           super(addr)
         end
       end
@@ -77,7 +77,7 @@ module PacketGen
           Option.constants.each do |cst|
             next unless cst.to_s.end_with? '_TYPE'
 
-            optname = cst.to_s.sub(/_TYPE/, '')
+            optname = cst.to_s.sub('_TYPE', '')
             @types[optname] = Option.const_get(cst)
           end
           @types

data/lib/packetgen/header/ipv6/addr.rb

@@ -107,7 +107,7 @@ module PacketGen
         # @return [self]
         #   array << '2001:1234::125'
         def push(addr)
-          addr = addr.is_a?(Addr) ? addr : Addr.new.from_human(addr)
+          addr = Addr.new.from_human(addr) unless addr.is_a?(Addr)
           super(addr)
         end
       end

data/lib/packetgen/header/ospfv2/lsa_header.rb

@@ -78,7 +78,7 @@ module PacketGen
         # @return [Integer]
         def calc_checksum
           c0 = c1 = 0
-          to_s[2..-1].unpack('C*').each do |byte|
+          to_s[2..].unpack('C*').each do |byte|
             c0 += byte
             c1 += c0
           end

data/lib/packetgen/header/ospfv3/lsa_header.rb

@@ -79,7 +79,7 @@ module PacketGen
         # @return [Integer]
         def calc_checksum
           c0 = c1 = 0
-          to_s[2..-1].unpack('C*').each do |byte|
+          to_s[2..].unpack('C*').each do |byte|
             c0 += byte
             c1 += c0
           end

data/lib/packetgen/header/tcp/options.rb

@@ -24,7 +24,7 @@ module PacketGen
           Option.constants.each do |cst|
             next unless cst.to_s.end_with? '_KIND'
 
-            optname = cst.to_s.sub(/_KIND/, '')
+            optname = cst.to_s.sub('_KIND', '')
             @klasses[Option.const_get(cst)] = TCP.const_get(optname)
           end
           @klasses

data/lib/packetgen/headerable.rb

@@ -46,7 +46,7 @@ module PacketGen
     def method_name
       return @method_name if defined? @method_name
 
-      @method_name = protocol_name.downcase.gsub(/::/, '_')
+      @method_name = protocol_name.downcase.gsub('::', '_')
     end
 
     # @abstract Should be redefined by subclasses. This method should check invariant

data/lib/packetgen/inspect.rb

@@ -36,7 +36,8 @@ module PacketGen
     # @param [Integer] hexsize
     # @return [String]
     def self.int_dec_hex(value, hexsize)
-      "%-16s (0x%0#{hexsize}x)" % [value.to_i, value.to_i]
+      fmt = "%-16s (0x%0#{hexsize}x)"
+      fmt % [value.to_i, value.to_i]
     end
 
     # @param [String] str
@@ -44,7 +45,8 @@ module PacketGen
     # @param [Integer] hexsize
     # @return [String]
     def self.enum_human_hex(str, int, hexsize)
-      "%-16s (0x%0#{hexsize}x)" % [str, int]
+      fmt = "%-16s (0x%0#{hexsize}x)"
+      fmt % [str, int]
     end
 
     # Simple formatter to inspect an attribute
@@ -90,7 +92,8 @@ module PacketGen
       val = case attr
             when RASN1::Types::Enumerated
               hexsize = attr.value_size * 2
-              "%-16s (0x%0#{hexsize}x)" % [attr.value, attr.to_i]
+              fmt = "%-16s (0x%0#{hexsize}x)"
+              fmt % [attr.value, attr.to_i]
             when RASN1::Types::Integer
               int_dec_hex(attr.value, attr.value_size * 2)
             when RASN1::Model

data/lib/packetgen/packet.rb

@@ -81,7 +81,9 @@ module PacketGen
     # @see Capture#initialize
     # @yieldparam [Packet,String] packet if a block is given, yield each
     #    captured packet (Packet or raw data String, depending on +:parse+ option)
+    # @yieldparam [Time] timestamp packet timestamp
     # @return [Array<Packet>] captured packet
+    # @since 3.3.0 add packet timestamp as second yield parameter
     def self.capture(**kwargs, &block)
       capture = Capture.new(**kwargs)
       if block

data/lib/packetgen/pcapng/file.rb

@@ -21,11 +21,11 @@ module PacketGen
       }.freeze
 
       # @private
-      BLOCK_TYPES = PcapNG.constants(false).select { |c| c.to_s.include?('_TYPE') }.map do |c|
+      BLOCK_TYPES = PcapNG.constants(false).select { |c| c.to_s.include?('_TYPE') }.to_h do |c|
         type_value = PcapNG.const_get(c).to_i
         klass = PcapNG.const_get(c.to_s.delete_suffix('_TYPE'))
         [type_value, klass]
-      end.to_h.freeze
+      end.freeze
 
       # Get file sections
       # @return [Array]

data/lib/packetgen/pcaprub_wrapper.rb

@@ -44,7 +44,7 @@ module PacketGen
     # @param [Boolean] promisc
     # @param [String] filter BPF filter
     # @param [Boolean] monitor
-    # @yieldparam [String] packet_data binary packet data
+    # @yieldparam [String] packet_data packet data
     # @return [void]
     # @author Sylvain Daubert
     # @author optix2000 - add support for setting monitor mode
@@ -52,7 +52,7 @@ module PacketGen
     def self.capture(iface:, snaplen: DEFAULT_SNAPLEN, promisc: DEFAULT_PROMISC, filter: nil, monitor: nil, &block)
       pcap = self.open_iface(iface: iface, snaplen: snaplen, promisc: promisc, monitor: monitor)
       pcap.setfilter filter unless filter.nil?
-      pcap.each(&block)
+      pcap.each_packet(&block)
     end
 
     # Inject given data onto wire

data/lib/packetgen/proto.rb

@@ -19,7 +19,7 @@ module PacketGen
       proto_constants = Socket.constants.grep(/IPPROTO_/)
       @cache = {}
       proto_constants.each do |const_sym|
-        name = const_sym.to_s[8..-1].downcase
+        name = const_sym.to_s[8..].downcase
         number = Socket.const_get(const_sym)
         @cache[name] = number
       end

data/lib/packetgen/types/fields.rb

@@ -322,12 +322,14 @@ module PacketGen
             define << "def #{name}; self[:#{name}].to_i; end"
             define << "def #{name}=(val) self[:#{name}].value = val; end"
           else
+            # rubocop:disable Layout/LineContinuationLeadingSpace
             define << "def #{name}\n" \
                       "  to_and_from_human?(:#{name}) ? self[:#{name}].to_human : self[:#{name}]\n" \
                       'end'
             define << "def #{name}=(val)\n" \
                       "  to_and_from_human?(:#{name}) ? self[:#{name}].from_human(val) : self[:#{name}].read(val)\n" \
                       'end'
+            # rubocop:enable Layout/LineContinuationLeadingSpace
           end
 
           define.delete_at(1) if instance_methods.include? "#{name}=".to_sym
@@ -479,7 +481,7 @@ module PacketGen
         fields.each do |field|
           next unless present?(field)
 
-          obj = self[field].read str[start..-1]
+          obj = self[field].read str[start..]
           start += self[field].sz
           self[field] = obj unless obj == self[field]
         end
@@ -523,7 +525,7 @@ module PacketGen
       # Return object as a hash
       # @return [Hash] keys: attributes, values: attribute values
       def to_h
-        fields.map { |f| [f, @fields[f].to_human] }.to_h
+        fields.to_h { |f| [f, @fields[f].to_human] }
       end
 
       # Get offset of given field in {Fields} structure.

data/lib/packetgen/utils/arp_spoofer.rb

@@ -112,9 +112,11 @@ module PacketGen
 
       # Say if spoofing on given target is active or not
       # @param [String] target_ip target IP address
-      # @return [Boolean,nil]
+      # @return [Boolean]
       def active?(target_ip)
+        # rubocop:disable Style/ReturnNilInPredicateMethodDefinition
         return unless @targets.key?(target_ip)
+        # rubocop:enable Style/ReturnNilInPredicateMethodDefinition
 
         @targets[target_ip][:active]
       end

data/lib/packetgen/utils.rb

@@ -19,11 +19,11 @@ module PacketGen
     # @private
     ARP_FILTER = 'arp src %<ipaddr>s and ether dst %<hwaddr>s'
     # @private
-    MITM_FILTER = '((ip src %<target1>s and not ip dst %<local_ip>s) or' \
-                  ' (ip src %<target2>s and not ip dst %<local_ip>s) or' \
-                  ' (ip dst %<target1>s and not ip src %<local_ip>s) or' \
-                  ' (ip dst %<target2>s and not ip src %<local_ip>s))' \
-                  ' and ether dst %<local_mac>s'
+    MITM_FILTER = '((ip src %<target1>s and not ip dst %<local_ip>s) or ' \
+                  '(ip src %<target2>s and not ip dst %<local_ip>s) or ' \
+                  '(ip dst %<target1>s and not ip src %<local_ip>s) or ' \
+                  '(ip dst %<target2>s and not ip src %<local_ip>s)) ' \
+                  'and ether dst %<local_mac>s'
 
     # @private
     ARP_PATH = '/usr/sbin/arp'

data/lib/packetgen/version.rb

@@ -10,5 +10,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '3.2.2'
+  VERSION = '3.3.0'
 end

data/lib/packetgen.rb

@@ -64,8 +64,10 @@ module PacketGen
   # Shortcut for {Packet.capture}
   # Same arguments as {Capture#initialize}
   # @see Capture#initialize
-  # @yieldparam [Packet] packet
+  # @yieldparam [Packet,String] packet
+  # @yieldparam [Time] timestamp
   # @return [Array<Packet>]
+  # @since 3.3.0 add packet timestamp as second yield parameter
   def self.capture(**kwargs)
     Packet.capture(**kwargs) { |packet| yield packet if block_given? }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -30,76 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: rasn1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.12'
 description: |
   PacketGen is a network packet manipulation library. It allows reading, parsing
   and sending network packets with fun.
@@ -260,7 +212,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="