packetgen 3.1.5 → 3.1.6

data/lib/packetgen/header/eth.rb

@@ -33,7 +33,7 @@ module PacketGen
       # Ethernet MAC address, as a group of 6 bytes
       # @author Sylvain Daubert
       class MacAddr < Types::Fields
-        include Inspectable
+        include Types::Fieldable
 
         # @!attribute a0
         #  @return [Integer] first byte from MacAddr
@@ -63,12 +63,9 @@ module PacketGen
           bytes = str.split(/:/)
           raise ArgumentError, 'not a MAC address' unless bytes.size == 6
 
-          self[:a0].read(bytes[0].to_i(16))
-          self[:a1].read(bytes[1].to_i(16))
-          self[:a2].read(bytes[2].to_i(16))
-          self[:a3].read(bytes[3].to_i(16))
-          self[:a4].read(bytes[4].to_i(16))
-          self[:a5].read(bytes[5].to_i(16))
+          6.times do |i|
+            self["a#{i}".to_sym].read(bytes[i].to_i(16))
+          end
           self
         end
 
@@ -77,7 +74,6 @@ module PacketGen
         def to_human
           fields.map { |m| '%02x' % self[m] }.join(':')
         end
-        alias format_inspect to_human
 
         def ==(other)
           other.is_a?(self.class) &&

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

@@ -12,7 +12,7 @@ module PacketGen
       # @abstract Base class for HTTP headers.
       # @author Kent 'picat' Gruber
       class Headers
-        include Inspectable
+        include Types::Fieldable
 
         # Underlying Headers data (or nil).
         # @return [Hash, nil]
@@ -20,7 +20,7 @@ module PacketGen
         alias to_h data
 
         def initialize
-          @data = nil
+          @data = {}
         end
 
         # Populate object from a string or directly from a hash.
@@ -48,7 +48,7 @@ module PacketGen
 
           d = []
           @data.map do |k, v|
-            d << k + ': ' + v
+            d << "#{k}: #{v}"
           end
           d.join("\r\n") << "\r\n\r\n"
         end
@@ -58,7 +58,6 @@ module PacketGen
         def to_human
           @data
         end
-        alias format_inspect to_human
 
         # Read human-readable data to populate header data.
         # @param [String, Hash] data

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

@@ -67,23 +67,17 @@ module PacketGen
         # Read in the HTTP portion of the packet, and parse it.
         # @return [PacketGen::HTTP::Request]
         def read(str)
-          str = str.bytes.map!(&:chr).join unless str.valid_encoding?
-          vrb = HTTP::VERBS.detect { |verb| str.include?(verb) }
-          str = vrb + str.split(vrb)[-1]
-          str = str.split("\n").map(&:chomp)
-          first_line = str.shift.split
-          self[:verb].read first_line[0]
-          self[:path].read first_line[1]
-          self[:version].read first_line[2]
+          lines = lines(str)
+          first_line_words = lines.shift.split
+          self[:verb].read first_line_words[0]
+          self[:path].read first_line_words[1]
+          self[:version].read first_line_words[2]
+
           # requests can sometimes have a payload
-          if (data_index = str.find_index(''))
-            data    = str[data_index + 1..-1].join("\n")
-            headers = str[0..data_index - 1].join("\n")
-          else
-            headers = str.join("\n")
-          end
+          headers, data = headers_and_payload_from_lines(lines)
           self[:headers].read(headers)
-          self[:body].read data
+          self[:body].read(data)
+
           self
         end
 
@@ -94,8 +88,29 @@ module PacketGen
           raise FormatError, 'Missing #path.'    if self.path.empty?
           raise FormatError, 'Missing #version.' if self.version.empty?
 
-          str = +''
-          str << self[:verb] << ' ' << self[:path] << ' ' << self[:version] << "\r\n" << self[:headers].to_s << self[:body]
+          "#{self.verb.dup} #{self.path} #{self.version}\r\n#{self[:headers]}#{self.body}"
+        end
+
+        private
+
+        # @todo check verb is correct or raise a ParseError
+        def lines(str)
+          str = str.bytes.map!(&:chr).join unless str.valid_encoding?
+          # vrb = HTTP::VERBS.detect { |verb| str.include?(verb) }
+
+          str.split("\r\n").map(&:chomp)
+        end
+
+        def headers_and_payload_from_lines(lines)
+          if (data_index = lines.find_index(''))
+            data    = lines[data_index + 1..-1].join("\n")
+            headers = lines[0..data_index - 1].join("\n")
+          else
+            headers = lines.join("\n")
+            data = nil
+          end
+
+          [headers, data]
         end
       end
     end

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

@@ -104,7 +104,7 @@ module PacketGen
           raise FormatError, 'Missing #version.'     if self.version.empty?
 
           str = +''
-          str << self[:version] << ' ' << self[:status_code] << ' ' << self[:status_mesg] << "\r\n"
+          str << self.version << ' ' << self.status_code << ' ' << self.status_mesg << "\r\n"
           str << self[:headers].to_s if self[:headers].given?
           str << self.body
         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/igmpv3/group_record.rb

@@ -40,6 +40,8 @@ module PacketGen
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
       class GroupRecord < Types::Fields
+        include Types::Fieldable
+
         # Known record types
         RECORD_TYPES = {
           'MODE_IS_INCLUDE' => 1,

data/lib/packetgen/header/ip.rb

@@ -131,7 +131,7 @@ module PacketGen
       #  @since 2.2.0
       #  @return [Types::String]
       define_field :options, Options, optional: ->(h) { h.ihl > 5 },
-                  builder: ->(h, t) { t.new(length_from: -> { (h.ihl - 5) * 4 }) }
+                                      builder: ->(h, t) { t.new(length_from: -> { (h.ihl - 5) * 4 }) }
       # @!attribute body
       #  @return [Types::String,Header::Base]
       define_field :body, Types::String
@@ -166,7 +166,7 @@ module PacketGen
 
         data = hdr.to_s
         data << "\x00" if data.size.odd?
-        sum = data.unpack('n*').reduce(:+)
+        sum = data.unpack('n*').sum
 
         hdr.checksum = old_checksum if old_checksum
 
@@ -191,17 +191,10 @@ module PacketGen
       # @return [Integer]
       def calc_checksum
         # Checksum is only on header, so cannot use IP.sum16,
-        # which also calcultes checksum on #body.
-        checksum = (self[:u8].to_i << 8) | self.tos
-        checksum += self.length
-        checksum += self.id
-        checksum += self.frag
-        checksum += (self.ttl << 8) | self.protocol
-        checksum += (self[:src].to_i >> 16)
-        checksum += (self[:src].to_i & 0xffff)
-        checksum += self[:dst].to_i >> 16
-        checksum += self[:dst].to_i & 0xffff
-        options.to_s.unpack('n*').each { |x| checksum += x }
+        # which also calculates checksum on #body.
+        nb_words = ihl * 2
+        self.checksum = 0
+        checksum = to_s.unpack("n#{nb_words}").sum
         self[:checksum].value = IP.reduce_checksum(checksum)
       end
 
@@ -238,20 +231,9 @@ module PacketGen
         super do |attr|
           case attr
           when :u8
-            shift = Inspect.shift_level
-            str = Inspect.inspect_attribute(attr, self[attr])
-            str << shift << Inspect::FMT_ATTR % ['', 'version', version]
-            str << shift << Inspect::FMT_ATTR % ['', 'ihl', ihl]
+            inspect_u8
           when :frag
-            shift = Inspect.shift_level
-            str = Inspect.inspect_attribute(attr, self[attr])
-            flags = flag_rsv? ? %w[RSV] : []
-            flags << 'DF' if flag_df?
-            flags << 'MF' if flag_mf?
-            flags_str = flags.empty? ? 'none' : flags.join(',')
-            str << shift << Inspect::FMT_ATTR % ['', 'flags', flags_str]
-            foff = Inspect.int_dec_hex(fragment_offset, 4)
-            str << shift << Inspect::FMT_ATTR % ['', 'frag_offset', foff]
+            inspect_frag
           end
         end
       end
@@ -276,6 +258,25 @@ module PacketGen
         self[:src], self[:dst] = self[:dst], self[:src]
         self
       end
+
+      private
+
+      def inspect_u8
+        shift = Inspect.shift_level
+        str = Inspect.inspect_attribute(:u8, self[:u8])
+        str << shift << Inspect::FMT_ATTR % ['', 'version', version]
+        str << shift << Inspect::FMT_ATTR % ['', 'ihl', ihl]
+      end
+
+      def inspect_frag
+        shift = Inspect.shift_level
+        str = Inspect.inspect_attribute(:frag, self[:frag])
+        flags = %i[rsv df mf].select { |flag| send("flag_#{flag}?") }.map(&:upcase)
+        flags_str = flags.empty? ? 'none' : flags.join(',')
+        str << shift << Inspect::FMT_ATTR % ['', 'flags', flags_str]
+        foff = Inspect.int_dec_hex(fragment_offset, 4)
+        str << shift << Inspect::FMT_ATTR % ['', 'frag_offset', foff]
+      end
     end
 
     self.add_class IP

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

@@ -11,7 +11,7 @@ module PacketGen
       # IP address, as a group of 4 bytes
       # @author Sylvain Daubert
       class Addr < Types::Fields
-        include Inspectable
+        include Types::Fieldable
 
         # @!attribute a1
         #  @return [Integer] IP address first byte
@@ -26,7 +26,7 @@ module PacketGen
         #  @return [Integer] IP address fourth byte
         define_field :a4, Types::Int8
 
-        IPV4_ADDR_REGEX = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/
+        IPV4_ADDR_REGEX = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/.freeze
 
         # Read a dotted address
         # @param [String] str
@@ -49,7 +49,6 @@ module PacketGen
         def to_human
           fields.map { |f| self[f].to_i.to_s }.join('.')
         end
-        alias format_inspect to_human
 
         # Addr as an integer
         # @return [Integer]

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

@@ -26,6 +26,8 @@ module PacketGen
       # Base class for IP options
       # @author Sylvain Daubert
       class Option < Types::Fields
+        include Types::Fieldable
+
         # EOL option type
         EOL_TYPE = 0x00
         # NOP option type
@@ -115,10 +117,8 @@ module PacketGen
         # Get a human readable string
         # @return [String]
         def to_human
-          str = self.class == Option ? +"unk-#{type}" : self.class.to_s.sub(/.*::/, '')
-          if respond_to?(:length) && (length > 2) && !self[:data].to_s.empty?
-            str << ":#{self[:data].to_s.inspect}"
-          end
+          str = self.instance_of?(Option) ? +"unk-#{type}" : self.class.to_s.sub(/.*::/, '')
+          str << ":#{self[:data].to_s.inspect}" if respond_to?(:length) && (length > 2) && !self[:data].to_s.empty?
           str
         end
       end

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

@@ -14,7 +14,7 @@ module PacketGen
       # IPv6 address, as a group of 8 2-byte words
       # @author Sylvain Daubert
       class Addr < Types::Fields
-        include Inspectable
+        include Types::Fieldable
 
         # @!attribute a1
         #  1st 2-byte word of IPv6 address
@@ -75,7 +75,6 @@ module PacketGen
         def to_human
           IPAddr.new(to_a.map { |a| a.to_i.to_s(16) }.join(':')).to_s
         end
-        alias format_inspect to_human
 
         # Return an array of address 16-bit words
         # @return [Array<Integer>]

data/lib/packetgen/header/mldv2/mcast_address_record.rb

@@ -52,6 +52,8 @@ module PacketGen
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
       class McastAddressRecord < Types::Fields
+        include Types::Fieldable
+
         # Known record types
         RECORD_TYPES = IGMPv3::GroupRecord::RECORD_TYPES
 

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

@@ -14,6 +14,8 @@ module PacketGen
       # * and {#advertising_router}.
       # @author Sylvain Daubert
       class LSR < Types::Fields
+        include Types::Fieldable
+
         # @!attribute type
         #  The type of the LSA to request.
         #  @return [Integer]

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

@@ -23,6 +23,8 @@ module PacketGen
       # LSA router payload}.
       # @author Sylvain Daubert
       class TosMetric < Types::Fields
+        include Types::Fieldable
+
         # @!attribute tos
         #  8-bit IP Type of Service that this metric refers to.
         #  @return [Integer]
@@ -52,6 +54,8 @@ module PacketGen
       # This class handles links in a {LSARouter LSA router payload}.
       # @author Sylvain Daubert
       class Link < Types::Fields
+        include Types::Fieldable
+
         # @!attribute id
         #  @return [IP::Addr]
         define_field :id, IP::Addr
@@ -136,6 +140,8 @@ module PacketGen
       # This class handles external links in {LSAASExternal LSA AS-External payloads}.
       # @author Sylvain Daubert
       class External < Types::Fields
+        include Types::Fieldable
+
         # @!attribute u8
         #  @return [Integer]
         define_field :u8, Types::Int8

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

@@ -29,6 +29,8 @@ module PacketGen
       # is also a base class for different LSA class, as {LSARouter}.
       # @author Sylvain Daubert
       class LSAHeader < Types::Fields
+        include Types::Fieldable
+
         # LSA Types
         TYPES = {
           'Router' => 1,
@@ -75,7 +77,6 @@ module PacketGen
         # Compute and set Fletcher-16 checksum on LSA
         # @return [Integer]
         def calc_checksum
-          self.checksum = 0
           bytes = to_s[2..-1].unpack('C*')
 
           c0 = c1 = 0

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

@@ -17,6 +17,8 @@ module PacketGen
       #   array consumes ((PrefixLength + 31) / 32) 32-bit words.
       # @author Sylvain Daubert
       class IPv6Prefix < Types::Fields
+        include Types::Fieldable
+
         # @!attribute length
         #  Prefix length, in bits
         #  @return [Integer]

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

@@ -27,6 +27,8 @@ module PacketGen
       # * and a 32-bit {#advertising_router} field.
       # @author Sylvain Daubert
       class LSR < Types::Fields
+        include Types::Fieldable
+
         # @!attribute reserved
         #  reserved field.
         #  @return [Integer]

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

@@ -11,6 +11,8 @@ module PacketGen
       # This class handles links in a {LSARouter OSPFv3 LSA router payload}.
       # @author Sylvain Daubert
       class Link < Types::Fields
+        include Types::Fieldable
+
         # @!attribute type
         #  @return [Integer]
         define_field :type, Types::Int8

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

@@ -29,6 +29,8 @@ module PacketGen
       # But this class is also a base class for different LSA class, as {LSARouter}.
       # @author Sylvain Daubert
       class LSAHeader < Types::Fields
+        include Types::Fieldable
+
         # LSA known types
         TYPES = {
           'Router' => 0x2001,
@@ -76,7 +78,6 @@ module PacketGen
         # Compute and set Fletcher-16 checksum on LSA
         # @return [Integer]
         def calc_checksum
-          self.checksum = 0
           bytes = to_s[2..-1].unpack('C*')
 
           c0 = c1 = 0

data/lib/packetgen/header/snmp.rb

@@ -246,7 +246,8 @@ module PacketGen
       end
 
       sequence :message,
-               content: [integer(:version, value: 'v2c',
+               content: [integer(:version,
+                                 value: 'v2c',
                                  enum: { 'v1' => 0, 'v2c' => 1, 'v2' => 2, 'v3' => 3 }),
                          octet_string(:community, value: 'public'),
                          model(:data, PDUs)]
@@ -295,7 +296,7 @@ module PacketGen
           begin
             str << Inspect.inspect_body(self[:message].to_der, 'ASN.1 DER')
           rescue StandardError => e
-            raise unless e.message =~ /TAG.*not handled/
+            raise unless e.message.match?(/TAG.*not handled/)
           end
           str
         end

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

@@ -11,6 +11,8 @@ module PacketGen
       # Base class to describe a TCP option
       # @author Sylvain Daubert
       class Option < Types::Fields
+        include Types::Fieldable
+
         # EOL option value
         EOL_KIND       = 0
         # NOP option value
@@ -91,15 +93,15 @@ module PacketGen
         # Setter for value attribute
         # @param[String,Integer]
         # @return [String, Integer]
-        def value=(v)
+        def value=(val)
           case self[:value]
           when Types::Int
             self.length = 2 + self[:value].sz
-          when String
-            self.length = 2 + Types::String.new.read(v).sz
+          when Types::String
+            self.length = 2 + Types::String.new.read(val).sz
           end
-          self[:value].read v
-          v
+          self[:value].read val
+          val
         end
 
         # Get binary string
@@ -112,7 +114,7 @@ module PacketGen
         # Get option as a human readable string
         # @return [String]
         def to_human
-          str = self.class == Option ? +"unk-#{kind}" : self.class.to_s.sub(/.*::/, '')
+          str = self.instance_of?(Option) ? +"unk-#{kind}" : self.class.to_s.sub(/.*::/, '')
           str << ":#{self[:value].to_s.inspect}" if (length > 2) && !self[:value].to_s.empty?
           str
         end