packetgen 3.1.6 → 3.2.1

data/lib/packetgen/header/mdns.rb

@@ -31,32 +31,10 @@ module PacketGen
         case iph
         when IP
           iph.dst = '224.0.0.251'
-          llh = ll_header(self)
-          mac = case llh
-                when Eth
-                  llh[:dst]
-                when Dot11
-                  if llh.to_ds?
-                    llh[:mac3]
-                  else
-                    llh[:mac1]
-                  end
-                end
-          mac.from_human('01:00:5E:00:00:FB')
+          dst_mac.from_human('01:00:5E:00:00:FB')
         when IPv6
           iph.dst = 'ff02::fb'
-          llh = ll_header(self)
-          mac = case llh
-                when Eth
-                  llh[:dst]
-                when Dot11
-                  if llh.to_ds?
-                    llh[:mac3]
-                  else
-                    llh[:mac1]
-                  end
-                end
-          mac.from_human('33:33:00:00:00:FB')
+          dst_mac.from_human('33:33:00:00:00:FB')
         end
       end
 
@@ -67,12 +45,28 @@ module PacketGen
       #  Needed by new bind API.
       def added_to_packet(packet)
         mdns_idx = packet.headers.size
-        packet.instance_eval "def mdnsize() @headers[#{mdns_idx}].mdnsize; end"
+        packet.instance_eval "def mdnsize() @headers[#{mdns_idx}].mdnsize; end" # def mdnsize() @headers[4].mdnsize; end
         return unless packet.is? 'UDP'
         return unless packet.udp.sport.zero?
 
         packet.udp.sport = UDP_PORT
       end
+
+      private
+
+      def dst_mac
+        llh = ll_header(self)
+        case llh
+        when Eth
+          llh[:dst]
+        when Dot11
+          if llh.to_ds?
+            llh[:mac3]
+          else
+            llh[:mac1]
+          end
+        end
+      end
     end
 
     self.add_class MDNS

data/lib/packetgen/header/mld.rb

@@ -68,7 +68,7 @@ module PacketGen
       #       directly called
       def added_to_packet(packet)
         mld_idx = packet.headers.size
-        packet.instance_eval "def mldize() @headers[#{mld_idx}].mldize; end"
+        packet.instance_eval "def mldize() @headers[#{mld_idx}].mldize; end" # def mldize() @headers[3].mldize; end
       end
 
       # Fixup IP header according to RFC 2710:

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/ospfv2/lsa_header.rb

@@ -77,17 +77,15 @@ module PacketGen
         # Compute and set Fletcher-16 checksum on LSA
         # @return [Integer]
         def calc_checksum
-          bytes = to_s[2..-1].unpack('C*')
-
           c0 = c1 = 0
-          bytes.each do |byte|
+          to_s[2..-1].unpack('C*').each do |byte|
             c0 += byte
             c1 += c0
           end
           c0 %= 255
           c1 %= 255
 
-          x = ((sz - 16 - 1) * c0 - c1) % 255
+          x = ((sz - 17) * c0 - c1) % 255
           x += 255 if x <= 0
           y = 255 * 2 - c0 - x
           y -= 255 if y > 255

data/lib/packetgen/header/ospfv2.rb

@@ -167,7 +167,7 @@ module PacketGen
       #       directly called
       def added_to_packet(packet)
         ospf_idx = packet.headers.size
-        packet.instance_eval "def ospfize(**kwargs) @headers[#{ospf_idx}].ospfize(**kwargs); end"
+        packet.instance_eval "def ospfize(**kwargs) @headers[#{ospf_idx}].ospfize(**kwargs); end" # def ospfize(**kwargs) @headers[2].ospfize(**kwargs); end
       end
 
       # Compute checksum and set +checksum+ field

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

@@ -71,11 +71,8 @@ module PacketGen
         # @param [String] str
         # @return [void]
         def from_human(str)
-          pfx, len = str.split('/')
-          len = (len || 128).to_i
-          addr = IPv6::Addr.new.from_human(pfx)
-          ary_size = (len + 31) / 32
-          ary = addr.to_a[0...ary_size * 2]
+          ary, len = ary_and_prefix_len_from_str(str)
+
           self.prefix.clear
           ary.each_with_index do |v, i|
             if i.even?
@@ -86,6 +83,18 @@ module PacketGen
           end
           self.length = len
         end
+
+        private
+
+        def ary_and_prefix_len_from_str(str)
+          pfx, len = str.split('/')
+          len = (len || 128).to_i
+          addr = IPv6::Addr.new.from_human(pfx)
+          ary_size = (len + 31) / 32
+          ary = addr.to_a[0...ary_size * 2]
+
+          [ary, len]
+        end
       end
 
       # Array of {IPv6Prefix}

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

@@ -35,7 +35,7 @@ module PacketGen
         # @return [String]
         def to_human
           "Link<type:#{type},metric:#{metric},id:#{interface_id}," \
-          "neighbor_id:#{neighbor_interface_id},neighbor_router:#{neighbor_router_id}>"
+            "neighbor_id:#{neighbor_interface_id},neighbor_router:#{neighbor_router_id}>"
         end
       end
 
@@ -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/header/ospfv3/lsa_header.rb

@@ -78,17 +78,15 @@ module PacketGen
         # Compute and set Fletcher-16 checksum on LSA
         # @return [Integer]
         def calc_checksum
-          bytes = to_s[2..-1].unpack('C*')
-
           c0 = c1 = 0
-          bytes.each do |byte|
+          to_s[2..-1].unpack('C*').each do |byte|
             c0 += byte
             c1 += c0
           end
           c0 %= 255
           c1 %= 255
 
-          x = ((sz - 16 - 1) * c0 - c1) % 255
+          x = ((sz - 17) * c0 - c1) % 255
           x += 255 if x <= 0
           y = 255 * 2 - c0 - x
           y -= 255 if y > 255

data/lib/packetgen/header/ospfv3.rb

@@ -145,7 +145,7 @@ module PacketGen
       #       directly called
       def added_to_packet(packet)
         ospf_idx = packet.headers.size
-        packet.instance_eval "def ospfize(**kwargs) @headers[#{ospf_idx}].ospfize(**kwargs); end"
+        packet.instance_eval "def ospfize(**kwargs) @headers[#{ospf_idx}].ospfize(**kwargs); end" # def ospfize(**kwargs) @headers[2].ospfize(**kwargs); end
       end
 
       # Compute checksum and set +checksum+ field

data/lib/packetgen/header/snmp.rb

@@ -286,20 +286,11 @@ module PacketGen
       def inspect
         str = super
         str << Inspect.shift_level
-        if self[:data].chosen.nil?
-          str << Inspect::FMT_ATTR % [self[:data].type, :data, '']
-        else
-          data = self[:data]
-          str << Inspect::FMT_ATTR % [data.type, :data, data.chosen_value.type]
-          str << Inspect.dashed_line('ASN.1 content')
-          str << data.chosen_value.inspect(1)
-          begin
-            str << Inspect.inspect_body(self[:message].to_der, 'ASN.1 DER')
-          rescue StandardError => e
-            raise unless e.message.match?(/TAG.*not handled/)
-          end
-          str
-        end
+        str << if self[:data].chosen.nil?
+                 Inspect::FMT_ATTR % [self[:data].type, :data, '']
+               else
+                 inspect_data
+               end
       end
 
       # @api private
@@ -315,6 +306,21 @@ module PacketGen
 
         packet.udp.sport = packet.udp.dport
       end
+
+      private
+
+      def inspect_data
+        data = self[:data]
+        str = Inspect::FMT_ATTR % [data.type, :data, data.chosen_value.type]
+        str << Inspect.dashed_line('ASN.1 content')
+        str << data.chosen_value.inspect(1)
+        begin
+          str << Inspect.inspect_body(self[:message].to_der, 'ASN.1 DER')
+        rescue StandardError => e
+          raise unless e.message.match?(/TAG.*not handled/)
+        end
+        str
+      end
     end
 
     self.add_class SNMP

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

@@ -43,7 +43,7 @@ module PacketGen
         # @!attribute value
         #  @return [Integer,String] option value
         define_field :value, Types::String, optional: ->(h) { h.length? && h.length > 2 },
-                     builder: ->(h, t) { t.new(length_from: -> { h.length - 2 }) }
+                                            builder: ->(h, t) { t.new(length_from: -> { h.length - 2 }) }
 
         # @param [hash] options
         # @option options [Integer] :kind

data/lib/packetgen/header/tcp.rb

@@ -216,11 +216,7 @@ module PacketGen
           doff = Inspect.int_dec_hex(data_offset, 1)
           str << shift << Inspect::FMT_ATTR % ['', 'data_offset', doff]
           str << shift << Inspect::FMT_ATTR % ['', 'reserved', reserved]
-          flags = +''
-          %w[ns cwr ece urg ack psh rst syn fin].each do |fl|
-            flags << (send("flag_#{fl}?") ? fl[0].upcase : '.')
-          end
-          str << shift << Inspect::FMT_ATTR % ['', 'flags', flags]
+          str << shift << Inspect::FMT_ATTR % ['', 'flags', flags2string]
         end
       end
 
@@ -231,6 +227,17 @@ module PacketGen
         self[:sport], self[:dport] = self[:dport], self[:sport]
         self
       end
+
+      private
+
+      def flags2string
+        flags = +''
+        %w[ns cwr ece urg ack psh rst syn fin].each do |fl|
+          flags << (send("flag_#{fl}?") ? fl[0].upcase : '.')
+        end
+
+        flags
+      end
     end
 
     self.add_class TCP

data/lib/packetgen/header/tftp.rb

@@ -102,22 +102,18 @@ module PacketGen
         client_tid = packet.udp.sport
         server_tid = nil
         ary.each do |pkt|
+          next unless pkt.is?('UDP')
+
           if server_tid.nil?
-            next unless pkt.is?('UDP') && (pkt.udp.dport == client_tid)
+            next unless pkt.udp.dport == client_tid
 
             server_tid = pkt.udp.sport
           else
-            next unless pkt.is?('UDP')
-
             tids = [server_tid, client_tid]
             ports = [pkt.udp.sport, pkt.udp.dport]
             next unless (tids - ports).empty?
           end
-          tftp = Packet.parse(pkt.body, first_header: 'TFTP')
-          udp_dport = pkt.udp.dport
-          pkt.encapsulate tftp
-          # need to fix it as #encapsulate force it to 69
-          pkt.udp.dport = udp_dport
+          decode_tftp_packet(pkt)
         end
       end
 
@@ -135,7 +131,17 @@ module PacketGen
       def added_to_packet(packet)
         return if packet.respond_to? :tftp
 
-        packet.instance_eval("def tftp(arg=nil); header(#{self.class}, arg); end")
+        packet.instance_eval("def tftp(arg=nil); header(#{self.class}, arg); end") # def tftp(arg=nil); header(TFTP, arg); end
+      end
+
+      private
+
+      def decode_tftp_packet(pkt)
+        tftp = Packet.parse(pkt.body, first_header: 'TFTP')
+        udp_dport = pkt.udp.dport
+        pkt.encapsulate tftp
+        # need to fix it as #encapsulate force it to 69
+        pkt.udp.dport = udp_dport
       end
 
       # TFTP Read Request header

data/lib/packetgen/inspect.rb

@@ -12,6 +12,8 @@ module PacketGen
   module Inspect
     # Maximum number of characters on a line for INSPECT
     MAX_WIDTH = 70
+    # @private
+    SEPARATOR = ('-' * MAX_WIDTH << "\n").freeze
 
     # Format to inspect attribute
     FMT_ATTR = "%14s %16s: %s\n"
@@ -105,19 +107,23 @@ module PacketGen
       return '' if body.nil? || body.empty?
 
       str = dashed_line(name, 2)
-      str << (0..15).to_a.map { |v| ' %02d' % v }.join << "\n"
-      str << '-' * MAX_WIDTH << "\n"
+      0.upto(15) { |v| str << ' %02d' % v }
+      str << "\n" << SEPARATOR
       unless body.empty?
         (body.size / 16 + 1).times do |i|
-          octets = body.to_s[i * 16, 16].unpack('C*')
-          o_str = octets.map { |v| ' %02x' % v }.join
-          str << o_str
-          str << ' ' * (3 * 16 - o_str.size) unless o_str.size >= 3 * 16
-          str << '  ' << octets.map { |v| v < 128 && v > 31 ? v.chr : '.' }.join
-          str << "\n"
+          str << self.convert_body_slice(body.to_s[i * 16, 16])
         end
       end
-      str << '-' * MAX_WIDTH << "\n"
+      str << SEPARATOR
+    end
+
+    # @private
+    def self.convert_body_slice(bslice)
+      octets = bslice.unpack('C*')
+      str = octets.map { |v| ' %02x' % v }.join
+      str << ' ' * (48 - str.size) unless str.size >= 48
+      str << '  ' << octets.map { |v| (32..127).cover?(v) ? v.chr : '.' }.join
+      str << "\n"
     end
   end
 end

data/lib/packetgen/packet.rb

@@ -51,6 +51,9 @@ module PacketGen
     # Get packet headers, ordered as they appear in the packet.
     # @return [Array<Header::Base>]
     attr_reader :headers
+    # Activaye or deactivate header cache (activated by default)
+    # @return [Boolean]
+    attr_accessor :cache_headers
 
     # Create a new Packet
     # @param [String] protocol base protocol for packet
@@ -81,7 +84,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
@@ -121,6 +124,8 @@ module PacketGen
     # @private
     def initialize
       @headers = []
+      @header_cache = {}
+      @cache_headers = true
     end
 
     # Add a protocol header in packet.
@@ -166,7 +171,7 @@ module PacketGen
     # @raise [ArgumentError] unknown protocol
     def is?(protocol)
       klass = check_protocol protocol
-      headers.any? { |h| h.is_a? klass }
+      headers.any?(klass)
     end
 
     # Recalculate all packet checksums
@@ -216,7 +221,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
 
@@ -271,6 +276,7 @@ module PacketGen
         headers.delete(hdr)
         add_header(next_hdr, previous_header: prev_hdr) if prev_hdr && next_hdr
       end
+      invalidate_header_cache
     rescue ArgumentError => e
       raise FormatError, e.message
     end
@@ -287,7 +293,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
@@ -356,6 +362,7 @@ module PacketGen
       headers.each do |header|
         add_magic_header_method header
       end
+      invalidate_header_cache
     end
 
     # Give first header of packet
@@ -409,7 +416,7 @@ module PacketGen
     # @return [Header::Base]
     def header(klass, arg)
       layer = arg.is_a?(Integer) ? arg : 1
-      header = headers.select { |h| h.is_a? klass }[layer - 1]
+      header = find_header(klass, layer)
       return header unless arg.is_a? Hash
 
       arg.each do |key, value|
@@ -421,6 +428,19 @@ module PacketGen
       header
     end
 
+    # Get header from cache, or find it in packet
+    # @param [Class] klass
+    # @param [Integer] layer
+    # @return [Header::Base]
+    def find_header(klass, layer)
+      header = fetch_header_from_cache(klass, layer)
+      return header if header
+
+      header = headers.select { |h| h.is_a? klass }[layer - 1]
+      add_header_to_cache(header, klass, layer)
+      header
+    end
+
     # check if protocol is known
     # @param [String] protocol
     # @raise [ArgumentError] unknown protocol
@@ -438,6 +458,7 @@ module PacketGen
     # @return [void]
     # @raise [BindingError]
     def add_header(header, previous_header: nil, parsing: false)
+      invalidate_header_cache
       prev_header = previous_header || last_header
       add_to_previous_header(prev_header, header, parsing) if prev_header
 
@@ -521,6 +542,31 @@ module PacketGen
 
       nil
     end
+
+    def invalidate_header_cache
+      return unless cache_headers
+
+      @header_cache = {}
+    end
+
+    # Fetch header from cache if authorized
+    # @param [Class] klass
+    # @param [Integer] layer
+    # @return [Header::Base,nil]
+    def fetch_header_from_cache(klass, layer)
+      @header_cache.fetch(klass, []).fetch(layer - 1, nil) if cache_headers
+    end
+
+    # Add header to cache if authorized
+    # @param [Class] klass
+    # @param [Integer] layer
+    # @return [Header::Base,nil]
+    def add_header_to_cache(header, klass, layer)
+      return unless cache_headers
+
+      @header_cache[klass] ||= []
+      @header_cache[klass][layer - 1] = header
+    end
   end
 end
 

data/lib/packetgen/pcapng/file.rb

@@ -9,7 +9,7 @@ module PacketGen
   module PcapNG
     # PcapNG::File is a complete Pcap-NG file handler.
     # @author Sylvain Daubert
-    class File
+    class File # rubocop:disable Metrics/ClassLength
       # Known link types
       KNOWN_LINK_TYPES = {
         LINKTYPE_ETHERNET => 'Eth',
@@ -21,13 +21,11 @@ module PacketGen
       }.freeze
 
       # @private
-      BLOCK_TYPES = Hash[
-        PcapNG.constants(false).select { |c| c.to_s.include?('_TYPE') }.map do |c|
-          type_value = PcapNG.const_get(c).to_i
-          klass = PcapNG.const_get(c.to_s[0..-6]) # @todo use delete_suffix('_TYPE') when support for Ruby 2.4 will stop
-          [type_value, klass]
-        end
-      ].freeze
+      BLOCK_TYPES = PcapNG.constants(false).select { |c| c.to_s.include?('_TYPE') }.map 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
 
       # Get file sections
       # @return [Array]
@@ -204,7 +202,7 @@ module PacketGen
       # @return [Array] array of 2 elements: filename and size written
       # @todo for 4.0, replace +options+ by +append+ kwarg
       def to_file(filename, options={})
-        mode = (options[:append] && ::File.exist?(filename)) ? 'ab' : 'wb'
+        mode = options[:append] && ::File.exist?(filename) ? 'ab' : 'wb'
         ::File.open(filename, mode) { |f| f.write(self.to_s) }
         [filename, self.to_s.size]
       end
@@ -264,7 +262,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 +274,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 +287,7 @@ module PacketGen
           block = create_block_from_pkt(pkt, section, ts, 0)
           classify_block(section, block)
         end
+        self
       end
 
       # @return [String]
@@ -315,12 +315,12 @@ module PacketGen
         shb = parse_shb(SHB.new, io)
         raise InvalidFileError, 'no Section header found' unless shb.is_a?(SHB)
 
-        to_parse = if shb.section_len.to_i != 0xffffffffffffffff
-                     # Section length is defined
-                     StringIO.new(io.read(shb.section_len.to_i))
-                   else
+        to_parse = if shb.section_len.to_i == 0xffffffffffffffff
                      # section length is undefined
                      io
+                   else
+                     # Section length is defined
+                     StringIO.new(io.read(shb.section_len.to_i))
                    end
 
         until to_parse.eof?
@@ -386,6 +386,7 @@ module PacketGen
         end
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       # Extract and check options for #array_to_file
       def array_to_file_options_from_hash(options)
         %i[filename arr ts].each do |deprecated_opt|
@@ -402,6 +403,7 @@ module PacketGen
 
         [filename, ary, ts, ts_inc, append]
       end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       def create_new_shb_section
         section = SHB.new

data/lib/packetgen/pcapng.rb

@@ -41,6 +41,7 @@ module PacketGen
 
     # Base error class for PcapNG
     class Error < PacketGen::Error; end
+
     # Invalid PcapNG file error
     class InvalidFileError < Error; end
   end

data/lib/packetgen/pcaprub_wrapper.rb

@@ -38,8 +38,6 @@ module PacketGen
       pcap.activate
     end
 
-    # rubocop:disable Metrics/ParameterLists
-
     # Capture packets from a network interface
     # @param [String] iface interface name
     # @param [Integer] snaplen
@@ -57,8 +55,6 @@ module PacketGen
       pcap.each(&block)
     end
 
-    # rubocop:enable Metrics/ParameterLists
-
     # Inject given data onto wire
     # @param [String] iface interface name
     # @param [String] data to inject

data/lib/packetgen/types/abstract_tlv.rb

@@ -60,7 +60,7 @@ module PacketGen
     class AbstractTLV < Types::Fields
       include Fieldable
 
-      class <<self
+      class << self
         # @return [Hash]
         attr_accessor :aliases
         attr_accessor :header_in_length