packetgen 3.1.8 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 539fce01eed5ce8711896ea7c9f22d29e3878b5165676ff673dd527c748d1fdb
-  data.tar.gz: bd724c164c6adf60b772b1ead15f9861853f4723711fe44cfdf49520a16a78c7
+  metadata.gz: 8f3faa715cd36e918df79355267c50690bdde15f1566e23947d26890e7b89a82
+  data.tar.gz: d374447f230500b0c5be84b225d3a5576f019afc4870dc6512c659bc2e069d67
 SHA512:
-  metadata.gz: f63e7926b399ee2550fdb29fa688bf4c580ad7b8be2f0518089e94c758d1fb84d70f9e1f148c004d5008697b6dbf83bc32637f994119126ceace6e1ef259c1a0
-  data.tar.gz: 8be8c39afec1aee25250b7c8e7f1bbcc81f680356079cca3d179fc671f407d53a4365b6df72c58c9b2947df6e6fe1f80f28b3cb9d31f2dfa445b61aaa3de1693
+  metadata.gz: de7911facea630eaa2d3d4afd2ae15e1cbd927241ebf0c63ec096c64eac31c58e519d379476763c50fc1b4290029cec4b14dbf9e96ae9aa05dc06701cf45af32
+  data.tar.gz: 69881fc66b4af80177bdad4b5b2daa4bd28259596bbf8a36112998aa9a8c117c7c9898180372635fcc1b47376e2fab4fb5cece88be5c000277cdce825fb03168

data/lib/packetgen.rb

@@ -95,7 +95,15 @@ module PacketGen
   # Get default network interface (ie. first non-loopback declared interface)
   # @return [String]
   def self.default_iface
-    Interfacez.default
+    return @default_iface if defined? @default_iface
+
+    @default_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
+    end
   end
 
   # Get loopback network interface
@@ -126,6 +134,7 @@ require 'packetgen/types'
 require 'packetgen/pcapng'
 require 'packetgen/pcap'
 require 'packetgen/packet'
+require 'packetgen/unknown_packet'
 require 'packetgen/capture'
 require 'packetgen/inject'
 require 'packetgen/proto'

data/lib/packetgen/capture.rb

@@ -122,7 +122,11 @@ module PacketGen
     def add_packet(data, &block)
       raw_packets << data
       if @parse
-        packet = Packet.parse(data)
+        begin
+          packet = Packet.parse(data)
+        rescue ParseError
+          packet = UnknownPacket.new.parse(data)
+        end
         packets << packet
         block&.call(packet)
       elsif block

data/lib/packetgen/header/asn1_base.rb

@@ -19,14 +19,20 @@ module PacketGen
     class ASN1Base < RASN1::Model
       include Headerable
 
-      # Define some methods from given ASN.1 fields to mimic {Base} attributes
-      # @param [Array<Symbol>] attributes
-      # @return [void]
-      def self.define_attributes(*attributes)
-        @attributes = attributes
-        attributes.each do |attr|
-          class_eval "def #{attr}; @elements[:#{attr}].value; end\n" \
-                     "def #{attr}=(v); @elements[:#{attr}].value = v; end"
+      class <<self
+        # Define some methods from given ASN.1 fields to mimic {Base} attributes
+        # @param [Array<Symbol>] attributes
+        # @return [void]
+        def define_attributes(*attributes)
+          @attributes = attributes
+          attributes.each do |attr|
+            class_eval "def #{attr}; @elements[:#{attr}].value; end\n" \
+                      "def #{attr}=(v); @elements[:#{attr}].value = v; end"
+          end
+        end
+
+        def known_headers
+          @known_headers ||= {}.freeze
         end
       end
 
@@ -37,7 +43,11 @@ module PacketGen
       # @param [String] str
       # @return [ASN1Base] self
       def read(str)
-        parse(str, ber: true)
+        begin
+          parse(str, ber: true)
+        rescue RASN1::ASN1Error
+          # suppress exception to allow guessing
+        end
         self
       end
 

data/lib/packetgen/header/dot11/data.rb

@@ -67,59 +67,49 @@ module PacketGen
         # Get destination MAC address
         # @return [String]
         def dst
-          ds = frame_ctrl & 3
-          case ds
-          when 0, 2
-            self.mac1
-          when 1, 3
-            self.mac3
-          end
+          _src_mac, dst_mac = src_dst_from_mac
+          self.send(dst_mac)
         end
 
         # Set destination MAC address
         # @param [String] mac MAC address to set
         # @return [String]
         def dst=(mac)
-          ds = frame_ctrl & 3
-          case ds
-          when 0, 2
-            self.mac1 = mac
-          when 1, 3
-            self.mac3 = mac
-          end
+          _src_mac, dst_mac = src_dst_from_mac
+          self.send("#{dst_mac}=", mac)
         end
 
         # Get source MAC address
         # @return [String]
         def src
-          ds = frame_ctrl & 3
-          case ds
-          when 0, 1
-            self.mac2
-          when 2
-            self.mac3
-          when 3
-            self.mac4
-          end
+          src_mac, = src_dst_from_mac
+          self.send(src_mac)
         end
 
         # Set source MAC address
         # @param [String] mac MAC address to set
         # @return [String]
         def src=(mac)
+          src_mac, = src_dst_from_mac
+          self.send("#{src_mac}=", mac)
+        end
+
+        private
+
+        def src_dst_from_mac
           ds = frame_ctrl & 3
           case ds
-          when 0, 1
-            self.mac2 = mac
+          when 0
+            %i[mac2 mac1]
+          when 1
+            %i[mac2 mac3]
           when 2
-            self.mac3 = mac
+            %i[mac3 mac1]
           when 3
-            self.mac4 = mac
+            %i[mac4 mac3]
           end
         end
 
-        private
-
         def define_applicable_fields
           super
           if (subtype >= 8) && !@applicable_fields.include?(:qos_ctrl)

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

@@ -81,6 +81,10 @@ module PacketGen
           self
         end
 
+        def parse?
+          VERBS.include?(self.verb) && self.version.start_with?('HTTP/1.')
+        end
+
         # String representation of data.
         # @return [String]
         def to_s
@@ -116,6 +120,6 @@ module PacketGen
     end
 
     self.add_class HTTP::Request
-    TCP.bind HTTP::Request, body: ->(b) { HTTP::REQUEST_REGEX =~ b.chars.select(&:valid_encoding?).join }
+    TCP.bind HTTP::Request, body: ->(b) { b.nil? ? '' : HTTP::REQUEST_REGEX =~ b }
   end
 end

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

@@ -87,15 +87,21 @@ module PacketGen
           end
           unless headers.empty?
             first_line = headers.shift.split
-            self[:version].read first_line[0]
-            self[:status_code].read first_line[1]
-            self[:status_mesg].read first_line[2..-1].join(' ')
+            if first_line.size >= 3
+              self[:version].read first_line[0]
+              self[:status_code].read first_line[1]
+              self[:status_mesg].read first_line[2..-1].join(' ')
+            end
             self[:headers].read(headers.join("\n"))
           end
           self[:body].read data.join("\n")
           self
         end
 
+        def parse?
+          version.start_with?('HTTP/1.')
+        end
+
         # String representation of data.
         # @return [String]
         def to_s
@@ -112,6 +118,6 @@ module PacketGen
     end
 
     self.add_class HTTP::Response
-    TCP.bind HTTP::Response, body: ->(b) { %r[^HTTP/1\.1\s\d{3,}\s.+] =~ b.chars.select(&:valid_encoding?).join }
+    TCP.bind HTTP::Response, body: ->(b) { b.nil? ? '' : %r[^HTTP/1\.1\s\d{3,}\s.+] =~ b }
   end
 end

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

@@ -16,7 +16,7 @@ module PacketGen
       VERBS = %w[GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH].freeze
 
       # Identifiable HTTP request regular expression.
-      REQUEST_REGEX = Regexp.new("(#{VERBS.dup.join('|')})\\s+\\S+\\s+HTTP/1.1")
+      REQUEST_REGEX = Regexp.new("^(#{VERBS.dup.join('|')})\\s+\\S+\\s+HTTP/1.1")
     end
   end
 end

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

@@ -229,9 +229,13 @@ module PacketGen
 
         def get_lsa_class_by_human_type(htype)
           klassname = "LSA#{htype.to_s.delete('-')}"
-          if OSPFv2.const_defined? klassname
-            OSPFv2.const_get klassname
-          else
+          begin
+            if OSPFv2.const_defined? klassname
+              OSPFv2.const_get klassname
+            else
+              LSA
+            end
+          rescue NameError
             LSA
           end
         end

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

@@ -218,9 +218,13 @@ module PacketGen
 
         def get_lsa_class_by_human_type(htype)
           klassname = "LSA#{htype.to_s.delete('-')}"
-          if OSPFv3.const_defined? klassname
-            OSPFv3.const_get klassname
-          else
+          begin
+            if OSPFv3.const_defined? klassname
+              OSPFv3.const_get klassname
+            else
+              LSA
+            end
+          rescue NameError
             LSA
           end
         end

data/lib/packetgen/packet.rb

@@ -81,7 +81,7 @@ module PacketGen
     # @return [Array<Packet>] captured packet
     def self.capture(**kwargs, &block)
       capture = Capture.new(**kwargs)
-      if block_given?
+      if block
         capture.start(&block)
       else
         capture.start
@@ -216,7 +216,7 @@ module PacketGen
     # @return [Array] see return from {PcapNG::File#to_file}
     # @see File
     def to_f(filename)
-      PcapNG::File.new.array_to_file(file: filename, array: [self])
+      PcapNG::File.new.read_array([self]).to_f(filename)
     end
     alias write to_f
 
@@ -287,7 +287,7 @@ module PacketGen
       if first_header.nil?
         # No decoding forced for first header. Have to guess it!
         first_header = guess_first_header(binary_str)
-        raise ParseError, 'cannot identify first header in string' if first_header.nil?
+        raise ParseError, "cannot identify first header in string: #{binary_str.inspect}" if first_header.nil?
       end
 
       add first_header

data/lib/packetgen/pcapng/file.rb

@@ -264,7 +264,7 @@ module PacketGen
       # @param [Time, nil] timestamp initial timestamp, used for first packet
       # @param [Numeric, nil] ts_inc timestamp increment, in seconds, to increment
       #                       initial timestamp for each packet
-      # @return [void]
+      # @return [self]
       # @note if +timestamp+ and/or +ts_inc+ are nil, {SPB} sections are created
       #  for each packet, else {EPB} ones are used
       # @since 3.1.6
@@ -276,11 +276,12 @@ module PacketGen
           classify_block(section, block)
           ts = update_ts(ts, ts_inc)
         end
+        self
       end
 
       # Update current object from a hash of packets and timestamps
       # @param [Hash{Time => Packet}] hsh
-      # @return [void]
+      # @return [self]
       # @since 3.1.6
       def read_hash(hsh)
         section = create_new_shb_section
@@ -288,6 +289,7 @@ module PacketGen
           block = create_block_from_pkt(pkt, section, ts, 0)
           classify_block(section, block)
         end
+        self
       end
 
       # @return [String]

data/lib/packetgen/unknown_packet.rb

@@ -0,0 +1,84 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  # Unknown packet, minimaly mimicking a {Packet}.
+  #
+  # An unknown packet is generated when capturing packets, and a packet cannot
+  # be parsed.
+  # @since 3.2.0
+  class UnknownPacket
+    # List of headers. Always empty
+    # @return [Array]
+    attr_reader :headers
+
+    def initialize
+      @headers = [].freeze
+      @binary_str = PacketGen.force_binary('')
+    end
+
+    # Unknown packet, so unknown protocol.
+    # @return [false]
+    def is?(_protocol)
+      false
+    end
+
+    # Get packet body
+    # @return [Types]
+    def body
+      @binary_str
+    end
+    alias to_s body
+
+    # Set packet body
+    # @param [String] str
+    # @return [void]
+    def body=(str)
+      @binary_str = PacketGen.force_binary(str)
+    end
+
+    # Write packet to a PCapNG file on disk.
+    # @param [String] filename
+    # @return [Array] see return from {PcapNG::File#to_file}
+    # @see File
+    def to_f(filename)
+      PcapNG::File.new.read_array([self]).to_f(filename)
+    end
+    alias write to_f
+
+    # Read binary string
+    # @param [String] binary_string
+    # @return [self]
+    def parse(binary_str, _first_header: nil)
+      @binary_str = PacketGen.force_binary(binary_str)
+      self
+    end
+
+    # @return [String]
+    def inspect
+      # TODO
+    end
+
+    # equality if {#to_s} is equal
+    # @return [Boolean]
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    # True only if +other+ is an {UnknownPacket} and +other == self+
+    # @return [Boolean]
+    def ===(other)
+      case other
+      when UnknwonPacket
+        self == other
+      else
+        false
+      end
+    end
+  end
+end

data/lib/packetgen/utils.rb

@@ -23,7 +23,7 @@ module PacketGen
       raw_cache = `/usr/sbin/arp -an`
 
       cache = {}
-      raw_cache.split(/\n/).each do |line|
+      raw_cache.split("\n").each do |line|
         match = line.match(/\((\d+\.\d+\.\d+\.\d+)\) at (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})(?: \[ether\])? on (\w+)/)
         cache[match[1]] = [match[2], match[4]] if match
       end
@@ -46,7 +46,7 @@ module PacketGen
     def self.arp(ipaddr, options={})
       unless options[:no_cache]
         local_cache = self.arp_cache
-        return local_cache[ipaddr].first if local_cache.key? ipaddr
+        return local_cache[ipaddr].first if local_cache.key?(ipaddr)
       end
 
       iface = options[:iface] || PacketGen.default_iface
@@ -54,13 +54,12 @@ module PacketGen
       my_hwaddr = Config.instance.hwaddr(iface)
       arp_pkt = Packet.gen('Eth', dst: 'ff:ff:ff:ff:ff:ff', src: my_hwaddr)
                       .add('ARP', sha: Config.instance.hwaddr(iface),
-                           spa: Config.instance.ipaddr(iface), tpa: ipaddr)
+                                  spa: Config.instance.ipaddr(iface),
+                                  tpa: ipaddr)
 
       capture = Capture.new(iface: iface, timeout: timeout, max: 1,
                             filter: "arp src #{ipaddr} and ether dst #{my_hwaddr}")
-      cap_thread = Thread.new do
-        capture.start
-      end
+      cap_thread = Thread.new { capture.start }
 
       arp_pkt.to_w(iface)
       cap_thread.join

data/lib/packetgen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.2.0
 platform: ruby
 authors:
 - Sylvain Daubert
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -233,10 +233,11 @@ files:
 - 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:
+homepage: 
 licenses:
 - MIT
 metadata:
@@ -245,7 +246,7 @@ metadata:
   bug_tracker_uri: https://github.com/sdaubert/packetgen/issues
   documentation_uri: https://www.rubydoc.info/gems/packetgen
   wiki_uri: https://github.com/sdaubert/packetgen/wiki
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--title"
 - PacketGen - network packet dissector
@@ -266,8 +267,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.2.5
+signing_key: 
 specification_version: 4
 summary: Network packet generator and dissector
 test_files: []