packetgen 2.8.7 → 3.0.0

data/lib/packetgen/header/mdns.rb

@@ -70,6 +70,7 @@ module PacketGen
         packet.instance_eval "def mdnsize() @headers[#{mdns_idx}].mdnsize; end"
         return unless packet.is? 'UDP'
         return unless packet.udp.sport.zero?
+
         packet.udp.sport = UDP_PORT
       end
     end

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

@@ -121,6 +121,8 @@ module PacketGen
           self[:max_resp_delay].value = MLDv2.encode(value)
         end
 
+        undef qqic, qqic=
+
         # Get QQIC value
         # @note May return a different value from value previously set, as a
         #   float encoding is used to encode big values. See {IGMPv3.decode}.

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

@@ -74,7 +74,7 @@ module PacketGen
 
         # @return [String]
         def to_human
-          "Link<type:#{type},metric:#{metric},id:#{id},data:#{data}>"
+          "<type:#{type},metric:#{metric},id:#{id},data:#{data}>"
         end
       end
 
@@ -129,7 +129,8 @@ module PacketGen
         # @!attribute routers
         #  List of routers in network
         #  @return [IP::ArrayOfAddr]
-        define_field :routers, IP::ArrayOfAddr
+        define_field :routers, IP::ArrayOfAddr,
+                     builder: ->(h, t) { t.new(length_from: -> { h.length - 24 }) }
       end
 
       # This class handles external links in {LSAASExternal LSA AS-External payloads}.
@@ -153,6 +154,11 @@ module PacketGen
         # @!attribute tos
         #  @return [Integer]
         define_bit_fields_on :u8, :e_flag, :tos, 7
+
+        # @return [String]
+        def to_human
+          "<type:#{e_flag? ? 2 : 1},tos:#{tos},metric:#{metric},fwaddr:#{forwarding_addr},tag:#{ext_route_tag}>"
+        end
       end
 
       # This class defines a specialized {Types::Array array} to handle series
@@ -176,14 +182,15 @@ module PacketGen
         # @!attribute externals
         #  List of external destinations
         #  @return [ArrayOfExternal]
-        define_field :externals, ArrayOfExternal
+        define_field :externals, ArrayOfExternal,
+                     builder: ->(h, t) { t.new(length_from: -> { h.length - 24 }) }
       end
 
       # This class defines a specialized {Types::Array array} to handle series
       # of {LSA LSAs}. It recognizes known LSA types and infers correct type.
       # @author Sylvain Daubert
       class ArrayOfLSA < Types::Array
-        set_of LSA
+        set_of LSAHeader
 
         # @param [Hash] options
         # @option options [Types::Int] counter Int object used as a counter for this set
@@ -194,27 +201,6 @@ module PacketGen
           @only_headers = options[:only_headers] || false
         end
 
-        # Populate object from a string
-        # @param [String] str
-        # @return [self]
-        def read(str)
-          clear
-          return self if str.nil?
-          return self if @counter && @counter.to_i.zero?
-          force_binary str
-          until str.empty?
-            lsa = LSAHeader.new.read(str)
-            unless @only_headers
-              klass = get_lsa_class_by_human_type(lsa.human_type)
-              lsa = klass.new.read(str[0...lsa.length])
-            end
-            self.push lsa
-            str.slice!(0, lsa.sz)
-            break if @counter && (self.size == @counter.to_i)
-          end
-          self
-        end
-
         private
 
         def record_from_hash(hsh)
@@ -245,6 +231,10 @@ module PacketGen
             LSA
           end
         end
+
+        def real_type(lsah)
+          @only_headers ? lsah.class : get_lsa_class_by_human_type(lsah.human_type)
+        end
       end
     end
   end

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

@@ -33,7 +33,7 @@ module PacketGen
         # @!attribute prefix
         #  IPv6 Prefix as an array of 32-bit words
         #  @return [Prefix]
-        define_field :prefix, Types::ArrayOfInt32
+        define_field :prefix, Types::ArrayOfInt32, builder: ->(h, t) { t.new(length_from: -> { h.length / 8 }) }
 
         # @!attribute dn_opt
         #  This bit controls an inter-area-prefix-LSAs or AS-external-LSAs

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

@@ -72,7 +72,7 @@ module PacketGen
         OSPFv3.define_options(self)
         # @attribute links
         #  @return [ArrayOfLink]
-        define_field :links, ArrayOfLink
+        define_field :links, ArrayOfLink, builder: ->(h, t) { t.new(length_from: -> { h.length - h.offset_of(:links) }) }
 
         # @!attribute nt_flag
         #  @return [Boolean]
@@ -103,7 +103,7 @@ module PacketGen
         # @!attribute routers
         #  List of routers attached to the link.
         #  @return [IP::ArrayOfAddr]
-        define_field :routers, IP::ArrayOfAddr
+        define_field :routers, IP::ArrayOfAddr, builder: ->(h, t) { t.new(length_from: -> { h.length - h.offset_of(:routers) }) }
       end
 
       # This class handles OSPFv3 LSA Intra-Area-Prefix payloads.
@@ -175,7 +175,7 @@ module PacketGen
         # @!attribute prefixes
         #  List of IPv6 prefixes to be associated with the link.
         #  @return [ArrayOfIPv6Prefix]
-        define_field :prefixes, ArrayOfIPv6Prefix
+        define_field :prefixes, ArrayOfIPv6Prefix, builder: ->(h, t) { t.new(counter: h[:prefix_count]) }
       end
 
       # This class defines a specialized {Types::Array array} to handle series
@@ -183,7 +183,7 @@ module PacketGen
       # and infers correct type.
       # @author Sylvain Daubert
       class ArrayOfLSA < Types::Array
-        set_of LSA
+        set_of LSAHeader
 
         # @param [Hash] options
         # @option options [Types::Int] counter Int object used as a counter for this set
@@ -194,27 +194,6 @@ module PacketGen
           @only_headers = options[:only_headers] || false
         end
 
-        # Populate object from a string
-        # @param [String] str
-        # @return [self]
-        def read(str)
-          clear
-          return self if str.nil?
-          return self if @counter && @counter.to_i.zero?
-          force_binary str
-          until str.empty?
-            lsa = LSAHeader.new.read(str)
-            unless @only_headers
-              klass = get_lsa_class_by_human_type(lsa.human_type)
-              lsa = klass.new.read(str[0...lsa.length])
-            end
-            self.push lsa
-            str.slice!(0, lsa.sz)
-            break if @counter && (self.size == @counter.to_i)
-          end
-          self
-        end
-
         private
 
         def record_from_hash(hsh)
@@ -245,6 +224,10 @@ module PacketGen
             LSA
           end
         end
+
+        def real_type(lsah)
+          @only_headers ? lsah.class : get_lsa_class_by_human_type(lsah.human_type)
+        end
       end
     end
   end

data/lib/packetgen/header/snmp.rb

@@ -259,6 +259,7 @@ module PacketGen
         super
         data.chosen = options[:chosen_pdu] if options[:chosen_pdu]
         return unless options[:pdu]
+
         data.root.value[data.chosen] = data.root.chosen_value.class.new(options[:pdu])
       end
 
@@ -307,6 +308,7 @@ module PacketGen
       def added_to_packet(packet)
         return unless packet.is? 'UDP'
         return unless packet.udp.sport.zero?
+
         packet.udp.sport = packet.udp.dport
       end
     end

data/lib/packetgen/header/tcp.rb

@@ -7,6 +7,26 @@
 
 module PacketGen
   module Header
+    # TCP header ({https://tools.ietf.org/html/rfc793 RFC 793})
+    #    0                   1                   2                   3
+    #    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |          Source Port          |       Destination Port        |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                        Sequence Number                        |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                    Acknowledgment Number                      |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |  Data |           |U|A|P|R|S|F|                               |
+    #   | Offset| Reserved  |R|C|S|S|Y|I|            Window             |
+    #   |       |           |G|K|H|T|N|N|                               |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |           Checksum            |         Urgent Pointer        |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                    Options                    |    Padding    |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                             data                              |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A TCP header consists of:
     # * a source port ({#sport}, {Types::Int16} type),
     # * a destination port ({#dport}, +Int16+ type),
@@ -78,7 +98,7 @@ module PacketGen
       # @!attribute seqnum
       #  32-bit TCP sequence number
       #  @return [Integer]
-      define_field :seqnum, Types::Int32, default: ->(h) { rand(2**32) }
+      define_field :seqnum, Types::Int32, default: ->(_) { rand(2**32) }
       # @!attribute acknum
       #  32-bit TCP acknowledgement number
       #  @return [Integer]
@@ -174,6 +194,7 @@ module PacketGen
       # @return [self]
       def read(str)
         return self if str.nil?
+
         force_binary str
         self[:sport].read str[0, 2]
         self[:dport].read str[2, 2]
@@ -212,7 +233,7 @@ module PacketGen
           shift = Inspect.shift_level
           str = Inspect.inspect_attribute(attr, self[attr])
           doff = Inspect.int_dec_hex(data_offset, 1)
-          str<< shift << Inspect::FMT_ATTR % ['', 'data_offset', doff]
+          str << shift << Inspect::FMT_ATTR % ['', 'data_offset', doff]
           str << shift << Inspect::FMT_ATTR % ['', 'reserved', reserved]
           flags = ''.dup
           %w[ns cwr ece urg ack psh rst syn fin].each do |fl|

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

@@ -10,7 +10,7 @@ module PacketGen
     class TCP
       # Base class to describe a TCP option
       # @author Sylvain Daubert
-      class Option < Base
+      class Option < Types::Fields
         # EOL option value
         EOL_KIND       = 0
         # NOP option value
@@ -37,10 +37,11 @@ module PacketGen
         # @!attribute length
         #  Option length
         #  @return [Integer] 8-bit option length
-        define_field :length, Types::Int8
+        define_field :length, Types::Int8, optional: ->(h) { h.length? }
         # @!attribute value
         #  @return [Integer,String] option value
-        define_field :value, Types::String
+        define_field :value, Types::String, optional: ->(h) { h.length? && h.length > 2 },
+                     builder: ->(h, t) { t.new(length_from: -> { h.length - 2 }) }
 
         # @param [hash] options
         # @option options [Integer] :kind
@@ -59,40 +60,21 @@ module PacketGen
                     end
             self[:value] = klass.new(options[:value])
           when NilClass
-            self[:value] = Types::String.new
+            # Nothing to do
           else
             self[:value] = Types::String.new.read(options[:value])
             self[:length].read(self[:value].sz + 2) unless options[:length]
           end
         end
 
-        # Read a TCP option from a string
-        # @param [String] str binary string
-        # @return [self]
-        def read(str)
-          return self if str.nil?
-          force_binary str
-          self[:kind].read str[0, 1]
-          if str[1, 1]
-            self[:length].read str[1, 1]
-            self[:value].read str[2, length - 2] if str[2, 1] && length > 2
-          end
-          self
-        end
-
         # Say if given option has a length field.
         # @return [Boolean]
         # @since 2.7.0
         def length?
-          self[:kind].value && kind >= 2
+          kind >= 2
         end
 
-        # @deprecated Use {#length?}.
-        # @return [Boolean]
-        def has_length?
-          Deprecation.deprecated(self.class, __method__, 'length?')
-          length?
-        end
+        undef value
 
         # Getter for value attribute
         # @return [String, Integer]
@@ -105,19 +87,32 @@ module PacketGen
           end
         end
 
+        alias old_set_value value=
+        # Setter for value attribute
+        # @param[String,Integer]
+        # @return [String, Integer]
+        def value=(v)
+          case self[:value]
+          when Types::Int
+            self.length = 2 + self[:value].sz
+          when String
+            self.length = 2 + Types::String.new.read(v).sz
+          end
+          self[:value].read v
+          v
+        end
+
         # Get binary string
         # @return [String]
         def to_s
-          str = self[:kind].to_s
-          str << self[:length].to_s unless self[:length].value.nil?
-          str << self[:value].to_s if length > 2
-          str
+          self.length = 2 + self[:value].sz if length?
+          super
         end
 
         # 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.class == Option ? +"unk-#{kind}" : self.class.to_s.sub(/.*::/, '')
           if (length > 2) && !self[:value].to_s.empty?
             str << ":#{self[:value].to_s.inspect}"
           end
@@ -135,27 +130,25 @@ module PacketGen
       # End Of Option TCP option
       # @author Sylvain Daubert
       class EOL < Option
-        # @see Option#initialize
-        def initialize(options={})
-          super options.merge!(kind: EOL_KIND)
-        end
+        update_field :kind, default: EOL_KIND
       end
 
       # No OPeration TCP option
       # @author Sylvain Daubert
       class NOP < Option
         # @see Option#initialize
-        def initialize(options={})
-          super options.merge!(kind: NOP_KIND)
-        end
+        update_field :kind, default: NOP_KIND
       end
 
       # Maximum Segment Size TCP option
       # @author Sylvain Daubert
       class MSS < Option
+        update_field :kind, default: MSS_KIND
+        update_field :length, default: 4
+
         # @see Option#initialize
         def initialize(options={})
-          super options.merge!(kind: MSS_KIND, length: 4)
+          super
           self[:value] = Types::Int16.new(options[:value])
         end
 
@@ -168,9 +161,12 @@ module PacketGen
       # Window Size TCP option
       # @author Sylvain Daubert
       class WS < Option
+        update_field :kind, default: WS_KIND
+        update_field :length, default: 3
+
         # @see Option#initialize
         def initialize(options={})
-          super options.merge!(kind: WS_KIND, length: 3)
+          super
           self[:value] = Types::Int8.new(options[:value])
         end
 
@@ -183,28 +179,25 @@ module PacketGen
       # Selective Acknowledgment OK TCP option
       # @author Sylvain Daubert
       class SACKOK < Option
-        # @see Option#initialize
-        def initialize(options={})
-          super options.merge!(kind: SACKOK_KIND, length: 2)
-        end
+        update_field :kind, default: SACKOK_KIND
+        update_field :length, default: 2
       end
 
       # Selective Acknowledgment TCP option
       # @author Sylvain Daubert
       class SACK < Option
-        # @see Option#initialize
-        def initialize(options={})
-          super options.merge!(kind: SACK_KIND)
-          self[:length].read(2) if self[:value].to_s == ''
-        end
+        update_field :kind, default: SACK_KIND
       end
 
       # Echo TCP option
       # @author Sylvain Daubert
       class ECHO < Option
+        update_field :kind, default: ECHO_KIND
+        update_field :length, default: 6
+
         # @see Option#initialize
         def initialize(options={})
-          super options.merge!(kind: ECHO_KIND, length: 6)
+          super
           self[:value] = Types::Int32.new(options[:value])
         end
 
@@ -217,9 +210,12 @@ module PacketGen
       # Echo Reply TCP option
       # @author Sylvain Daubert
       class ECHOREPLY < Option
+        update_field :kind, default: ECHOREPLY_KIND
+        update_field :length, default: 6
+
         # @see Option#initialize
         def initialize(options={})
-          super options.merge!(kind: ECHOREPLY_KIND, length: 6)
+          super
           self[:value] = Types::Int32.new(options[:value])
         end
 
@@ -232,10 +228,13 @@ module PacketGen
       # Timestamp TCP option
       # @author Sylvain Daubert
       class TS < Option
+        update_field :kind, default: TS_KIND
+        update_field :length, default: 10
+
         # @see Option#initialize
         def initialize(options={})
-          super options.merge!(kind: TS_KIND, length: 10)
-          self[:value] = Types::String.new.read(options[:value] || "\0" * 8)
+          super
+          self[:value].read(options[:value] || "\0" * 8)
         end
 
         # @return [String]