packetgen 2.4.0 → 2.5.0

data/lib/packetgen/header/igmpv3.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
 
@@ -126,17 +128,8 @@ module PacketGen
       # Compute checksum and set +checksum+ field
       # @return [Integer]
       def calc_checksum
-        sum = (type << 8) | max_resp_code
-
-        payload = body.to_s
-        payload << "\x00" unless payload.size % 2 == 0
-        payload.unpack('n*').each { |x| sum += x; }
-
-        while sum > 0xffff do
-          sum = (sum & 0xffff) + (sum >> 16)
-        end
-        sum = ~sum & 0xffff
-        self[:checksum].value = (sum == 0) ? 0xffff : sum
+        sum = IP.sum16(self)
+        self.checksum = IP.reduce_checksum(sum)
       end
     end
 

data/lib/packetgen/header/igmpv3/group_record.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IGMPv3

data/lib/packetgen/header/igmpv3/mq.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IGMPv3

data/lib/packetgen/header/igmpv3/mr.rb

@@ -2,6 +2,8 @@
 # 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.
+
+# frozen_string_literal: true
 require_relative 'group_record'
 
 module PacketGen

data/lib/packetgen/header/ike.rb

@@ -1,3 +1,10 @@
+# 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.
+
+# frozen_string_literal: true
+
 module PacketGen
   module Header
 
@@ -167,7 +174,7 @@ module PacketGen
       # Calculate length field
       # @return [Integer]
       def calc_length
-        self[:length].value = self.sz
+        Base.calculate_and_set_length self
       end
 
       # IKE payloads
@@ -185,23 +192,23 @@ module PacketGen
       # @return [String]
       def inspect
         str = Inspect.dashed_line(self.class, 2)
-        to_h.each do |attr, value|
+        fields.each do |attr|
           next if attr == :body
           case attr
           when :flags
-            str_flags = ''
+            str_flags = ''.dup
             %w(r v i).each do |flag|
               str_flags << (send("flag_#{flag}?") ? flag.upcase : '.')
             end
             str << Inspect.shift_level(2)
-            str << Inspect::FMT_ATTR % [value.class.to_s.sub(/.*::/, ''), attr,
+            str << Inspect::FMT_ATTR % [self[attr].class.to_s.sub(/.*::/, ''), attr,
                                         str_flags]
           when :exchange_type
             str << Inspect.shift_level(2)
-            str << Inspect::FMT_ATTR % [value.class.to_s.sub(/.*::/, ''), attr,
+            str << Inspect::FMT_ATTR % [self[attr].class.to_s.sub(/.*::/, ''), attr,
                                         human_exchange_type]
           else
-            str << Inspect.inspect_attribute(attr, value, 2)
+            str << Inspect.inspect_attribute(attr, self[attr], 2)
           end
         end
         str

data/lib/packetgen/header/ike/auth.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ike/cert.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ike/certreq.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ike/id.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ike/ke.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ike/nonce.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ike/notify.rb

@@ -1,4 +1,11 @@
 # coding: utf-8
+# 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.
+
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ike/payload.rb

@@ -1,3 +1,10 @@
+# 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.
+
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE
@@ -67,6 +74,8 @@ module PacketGen
         # Compute length and set {#length} field
         # @return [Integer] new length
         def calc_length
+          # Here, #body is next payload, so body size should not be taken in
+          # account (payload's real body is #content).
           self[:length].value = sz - body.sz
         end
       end

data/lib/packetgen/header/ike/sa.rb

@@ -1,4 +1,11 @@
 # coding: utf-8
+# 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.
+
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE
@@ -268,13 +275,13 @@ module PacketGen
         # Compute length and set {#length} field
         # @return [Integer] new length
         def calc_length
-          self[:length].value = sz
+          Base.calculate_and_set_length self
         end
 
         # Get a human readable string
         # @return [String]
         def to_human
-          h = "#{human_type}(#{human_id}"
+          h = "#{human_type}(#{human_id}".dup
           h << ",#{attributes.to_human}" if attributes.size > 0
           h << ')'
         end
@@ -443,13 +450,13 @@ module PacketGen
         # @return [Integer] new length
         def calc_length
           transforms.each { |t| t.calc_length }
-          self[:length].value = sz
+          Base.calculate_and_set_length self
         end
 
         # Get a human readable string
         # @return [String]
         def to_human
-          str = "##{num} #{human_protocol}"
+          str = "##{num} #{human_protocol}".dup
           case spi_size
           when 4
             str << "(spi:0x%08x)" % Types::Int32.new.read(spi).to_i

data/lib/packetgen/header/ike/sk.rb

@@ -1,4 +1,11 @@
 # coding: utf-8
+# 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.
+
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ike/ts.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ike/vendor_id.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IKE

data/lib/packetgen/header/ip.rb

@@ -2,6 +2,8 @@
 # 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.
+
+# frozen_string_literal: true
 require 'socket'
 
 module PacketGen
@@ -76,7 +78,7 @@ require_relative 'ip/options'
       #  @return [Integer] first byte of IP header.
       define_field :u8, Types::Int8, default: 0x45
       # @!attribute tos
-      #   @return [Integer] 8-bit Type of Service value
+      #   @return [Integer] 8-bit Type of Service self[attr]
       define_field :tos, Types::Int8, default: 0
       # @!attribute length
       #   @return [Integer] 16-bit IP total length
@@ -88,10 +90,10 @@ require_relative 'ip/options'
       #   @return [Integer] 16-bit frag word
       define_field :frag, Types::Int16, default: 0
       # @!attribute ttl
-      #   @return [Integer] 8-bit Time To Live value
+      #   @return [Integer] 8-bit Time To Live self[attr]
       define_field :ttl, Types::Int8, default: 64
       # @!attribute protocol
-      #   @return [Integer] 8-bit upper protocol value
+      #   @return [Integer] 8-bit upper protocol self[attr]
       define_field :protocol, Types::Int8
       # @!attribute checksum
       #   @return [Integer] 16-bit IP header checksum
@@ -126,6 +128,43 @@ require_relative 'ip/options'
       #   @return [Integer] 13-bit fragment offset
       define_bit_fields_on :frag, :flag_rsv, :flag_df, :flag_mf, :fragment_offset, 13
 
+      # Helper method to compute sum of 16-bit words. Used to compute IP-style
+      # checksums.
+      # @param [#to_s] hdr header or other object on which calculates a sum
+      #   of 16-bit words.
+      # @return [Integer]
+      def IP.sum16(hdr)
+        old_checksum = nil
+        if hdr.respond_to? :checksum=
+          old_checksum = hdr.checksum
+          hdr.checksum = 0
+        end
+
+        data = hdr.to_s
+        data << "\x00" if data.size % 2 == 1
+        sum = data.unpack('n*').reduce(:+)
+
+        hdr.checksum = old_checksum if old_checksum
+        
+        sum
+      end
+
+      # Helper method to reduce an IP checksum.
+      # This method:
+      # * checks a checksum is not greater than 0xffff. If it is,
+      #   reduces it.
+      # * inverts reduced self[attr].
+      # * forces self[attr] to 0xffff if computed self[attr] is 0.
+      # @param [Integer] checksum checksum to reduce
+      # @return [Integer] reduced checksum
+      def IP.reduce_checksum(checksum)
+        while checksum > 0xffff do
+          checksum = (checksum & 0xffff) + (checksum >> 16)
+        end
+        checksum = ~checksum & 0xffff
+        (checksum == 0) ? 0xffff : checksum
+      end
+
       # Populate object from a binary string
       # @param [String] str
       # @return [Fields] self
@@ -154,6 +193,8 @@ require_relative 'ip/options'
       # Compute checksum and set +checksum+ field
       # @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
@@ -164,17 +205,13 @@ require_relative 'ip/options'
         checksum += self[:dst].to_i >> 16
         checksum += self[:dst].to_i & 0xffff
         options.to_s.unpack('n*').each { |x| checksum += x }
-        while checksum > 0xffff do
-          checksum = (checksum & 0xffff) + (checksum >> 16)
-        end
-        checksum = ~checksum & 0xffff
-        self[:checksum].value = (checksum == 0) ? 0xffff : checksum
+        self[:checksum].value = IP.reduce_checksum(checksum)
       end
 
       # Compute length and set +length+ field
       # @return [Integer]
       def calc_length
-        self[:length].value = self.sz
+        Base.calculate_and_set_length self
       end
 
       # Get IP part of pseudo header checksum.
@@ -201,9 +238,9 @@ require_relative 'ip/options'
       def inspect
         str = Inspect.dashed_line(self.class, 2)
         shift = Inspect.shift_level(2)
-        to_h.each do |attr, value|
+        fields.each do |attr|
           next if attr == :body
-          str << Inspect.inspect_attribute(attr, value, 2)
+          str << Inspect.inspect_attribute(attr, self[attr], 2)
           if attr == :u8
             str << shift + Inspect::FMT_ATTR % ['', 'version', version]
             str << shift + Inspect::FMT_ATTR % ['', 'ihl', ihl]

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

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IP
@@ -52,6 +54,12 @@ module PacketGen
           (self.a1 << 24) | (self.a2 << 16) | (self.a3 << 8) |
             self.a4
         end
+
+        # Return true if this address is a multicast one
+        # @return [Boolean]
+        def mcast?
+          self.a1 >= 224 && self.a1 <= 239
+        end
       end
     end
   end

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

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IP

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

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class IP

data/lib/packetgen/header/ipv6.rb

@@ -3,6 +3,8 @@
 # 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.
+
+# frozen_string_literal: true
 require 'ipaddr'
 
 module PacketGen
@@ -90,7 +92,7 @@ module PacketGen
       # Compute length and set +len+ field
       # @return [Integer]
       def calc_length
-        self.length = body.sz
+        Base.calculate_and_set_length self, header_in_size: false
       end
 
       # Get IPv6 part of pseudo header checksum.
@@ -136,9 +138,9 @@ module PacketGen
       # @return [String]
       def inspect
         str = Inspect.dashed_line(self.class, 2)
-        to_h.each do |attr, value|
+        fields.each do |attr|
           next if attr == :body
-          str << Inspect.inspect_attribute(attr, value, 2)
+          str << Inspect.inspect_attribute(attr, self[attr], 2)
           if attr == :u32
             shift = Inspect.shift_level(2)
             str << shift + Inspect::FMT_ATTR % ['', 'version', version]