packetgen 3.2.0 → 3.2.1

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
@@ -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
@@ -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
@@ -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
@@ -317,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?
@@ -388,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|
@@ -404,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

data/lib/packetgen/types/array.rb

@@ -62,7 +62,7 @@ module PacketGen
       HUMAN_SEPARATOR = ','
 
       # rubocop:disable Naming/AccessorMethodName
-      class <<self
+      class << self
         # Get class set with {.set_of}.
         # @return [Class]
         # @since 3.0.0
@@ -154,6 +154,8 @@ module PacketGen
         self
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
+
       # Populate object from a string
       # @param [String] str
       # @return [self]
@@ -171,6 +173,7 @@ module PacketGen
         end
         self
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Get size in bytes
       # @return [Integer]
@@ -228,18 +231,22 @@ module PacketGen
     class ArrayOfInt8 < Array
       set_of Int8
     end
+
     # Specialized array to handle serie of {Int16}.
     class ArrayOfInt16 < Array
       set_of Int16
     end
+
     # Specialized array to handle serie of {Int16le}.
     class ArrayOfInt16le < Array
       set_of Int16le
     end
+
     # Specialized array to handle serie of {Int32}.
     class ArrayOfInt32 < Types::Array
       set_of Types::Int32
     end
+
     # Specialized array to handle serie of {Int32le}.
     class ArrayOfInt32le < Types::Array
       set_of Types::Int32le

data/lib/packetgen/types/fields.rb

@@ -115,7 +115,7 @@ module PacketGen
       # @private bit field definitions
       @bit_fields = {}
 
-      class <<self
+      class << self
         # Get field definitions for this class.
         # @return [Hash]
         # @since 3.1.0
@@ -282,7 +282,7 @@ module PacketGen
           type = field_defs[attr].type
           raise TypeError, "#{attr} is not a PacketGen::Types::Int" unless type < Types::Int
 
-          total_size = type.new.width * 8
+          total_size = type.new.nbits
           idx = total_size - 1
 
           until args.empty?
@@ -358,15 +358,15 @@ module PacketGen
           clear_mask = compute_clear_mask(total_size, field_mask)
 
           class_eval <<-METHODS
-          def #{name}?
-            val = (self[:#{attr}].to_i & #{field_mask}) >> #{shift}
-            val != 0
-          end
-          def #{name}=(v)
-            val = v ? 1 : 0
-            self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}
-            self[:#{attr}].value |= val << #{shift}
-          end
+          def #{name}?                                                  # def bit?
+            val = (self[:#{attr}].to_i & #{field_mask}) >> #{shift}     #   val = (self[:attr}].to_i & 1}) >> 1
+            val != 0                                                    #   val != 0
+          end                                                           # end
+          def #{name}=(v)                                               # def bit=(v)
+            val = v ? 1 : 0                                             #   val = v ? 1 : 0
+            self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}  #   self[:attr].value = self[:attr].to_i & 0xfffd
+            self[:#{attr}].value |= val << #{shift}                     #   self[:attr].value |= val << 1
+          end                                                           # end
           METHODS
         end
 
@@ -375,13 +375,13 @@ module PacketGen
           clear_mask = compute_clear_mask(total_size, field_mask)
 
           class_eval <<-METHODS
-          def #{name}
-            (self[:#{attr}].to_i & #{field_mask}) >> #{shift}
-          end
-          def #{name}=(v)
-            self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}
-            self[:#{attr}].value |= (v & #{2**size - 1}) << #{shift}
-          end
+          def #{name}                                                   # def multibit
+            (self[:#{attr}].to_i & #{field_mask}) >> #{shift}           #   (self[:attr].to_i & 6) >> 1
+          end                                                           # end
+          def #{name}=(v)                                               # def multibit=(v)
+            self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}  #   self[:attr].value = self[:attr].to_i & 0xfff9
+            self[:#{attr}].value |= (v & #{2**size - 1}) << #{shift}    #   self[:attr].value |= (v & 3) << 1
+          end                                                           # end
           METHODS
         end
 
@@ -523,7 +523,7 @@ module PacketGen
       # Return object as a hash
       # @return [Hash] keys: attributes, values: attribute values
       def to_h
-        Hash[fields.map { |f| [f, @fields[f].to_human] }]
+        fields.map { |f| [f, @fields[f].to_human] }.to_h
       end
 
       # Get offset of given field in {Fields} structure.

data/lib/packetgen/types/int.rb

@@ -89,6 +89,13 @@ module PacketGen
         format_str % [to_i.to_s, to_i]
       end
 
+      # Return the number of bits used to encode this Int
+      # @return [Integer]
+      # @since 3.2.1
+      def nbits
+        width * 8
+      end
+
       private
 
       def format_str

data/lib/packetgen/types/oui.rb

@@ -32,7 +32,7 @@ module PacketGen
       def from_human(str)
         return self if str.nil?
 
-        bytes = str.split(/:/)
+        bytes = str.split(':')
         raise ArgumentError, 'not a OUI' unless bytes.size == 3
 
         self[:b2].read(bytes[0].to_i(16))

data/lib/packetgen/types/tlv.rb

@@ -56,12 +56,8 @@ module PacketGen
       def initialize(options={})
         Deprecation.deprecated_class(self.class, AbstractTLV)
         super
-        self[:type] = options[:t].new(self.type) if options[:t]
-        self[:length] = options[:l].new(self.length) if options[:l]
-        self[:value] = options[:v].new if options[:v]
-        self.type = options[:type] if options[:type]
-        self.value = options[:value] if options[:value]
-        self.length = options[:length] if options[:length]
+        initialize_types(options)
+        initialize_values(options)
       end
 
       # Populate object from a binary string
@@ -137,9 +133,9 @@ module PacketGen
                      else
                        '%s'
                      end
-        @lenstr ||= "%-#{(2**(self[:length].width * 8) - 1).to_s.size}u"
-        "#{name} type:#{@typestr} length:#{@lenstr} value:#{value.inspect}" % [human_type,
-                                                                               length]
+        lenstr = "%-#{(2**self[:length].nbits - 1).to_s.size}u"
+        "#{name} type:#{@typestr} length:#{lenstr} value:#{value.inspect}" % [human_type,
+                                                                              length]
       end
 
       private
@@ -147,6 +143,18 @@ module PacketGen
       def human_types?
         self.class.const_defined? :TYPES
       end
+
+      def initialize_types(options)
+        self[:type] = options[:t].new(self.type) if options[:t]
+        self[:length] = options[:l].new(self.length) if options[:l]
+        self[:value] = options[:v].new if options[:v]
+      end
+
+      def initialize_values(options)
+        self.type = options[:type] if options[:type]
+        self.value = options[:value] if options[:value]
+        self.length = options[:length] if options[:length]
+      end
     end
   end
 end