packetgen 3.1.1 → 3.1.6

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

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
-
 require_relative 'group_record'
 
 module PacketGen

data/lib/packetgen/header/ip.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
-
 require 'socket'
 
 module PacketGen
@@ -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
 
@@ -182,9 +182,7 @@ module PacketGen
       # @param [Integer] checksum checksum to reduce
       # @return [Integer] reduced checksum
       def self.reduce_checksum(checksum)
-        while checksum > 0xffff
-          checksum = (checksum & 0xffff) + (checksum >> 16)
-        end
+        checksum = (checksum & 0xffff) + (checksum >> 16) while checksum > 0xffff
         checksum = ~checksum & 0xffff
         checksum.zero? ? 0xffff : checksum
       end
@@ -193,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
 
@@ -240,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
@@ -278,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

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 # 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 IP
       # IP address, as a group of 4 bytes
       # @author Sylvain Daubert
       class Addr < Types::Fields
+        include Types::Fieldable
+
         # @!attribute a1
         #  @return [Integer] IP address first byte
         define_field :a1, Types::Int8
@@ -24,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
@@ -60,6 +62,11 @@ module PacketGen
         def mcast?
           self.a1 >= 224 && self.a1 <= 239
         end
+
+        def ==(other)
+          other.is_a?(self.class) &&
+            fields.all? { |attr| self[attr].value == other[attr].value }
+        end
       end
     end
   end

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

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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 IP
@@ -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
@@ -83,7 +85,7 @@ module PacketGen
 
         # Factory to build an option from its type
         # @return [Option]
-        def Option.build(options={})
+        def self.build(options={})
           type = options.delete(:type)
           klass = case type
                   when String
@@ -99,9 +101,7 @@ module PacketGen
         def initialize(options={})
           unless options[:type]
             opt_name = self.class.to_s.gsub(/.*::/, '')
-            if Option.const_defined? "#{opt_name}_TYPE"
-              options[:type] = Option.const_get("#{opt_name}_TYPE")
-            end
+            options[:type] = Option.const_get("#{opt_name}_TYPE") if Option.const_defined? "#{opt_name}_TYPE"
           end
           super
           self.length = sz if respond_to?(:length) && options[:length].nil?
@@ -117,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/ip/options.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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 IP
@@ -19,9 +19,7 @@ module PacketGen
         # @return [String]
         def to_s
           str = super
-          if str.length % 4 != 0
-            str += ([0] * (4 - (str.length % 4))).pack('C*')
-          end
+          str += ([0] * (4 - (str.length % 4))).pack('C*') if str.length % 4 != 0
           str
         end
 

data/lib/packetgen/header/ipv6.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
-
 require 'ipaddr'
 
 module PacketGen

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

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
-
 require 'ipaddr'
 
 module PacketGen
@@ -14,6 +14,8 @@ module PacketGen
       # IPv6 address, as a group of 8 2-byte words
       # @author Sylvain Daubert
       class Addr < Types::Fields
+        include Types::Fieldable
+
         # @!attribute a1
         #  1st 2-byte word of IPv6 address
         #  @return [Integer]
@@ -85,6 +87,11 @@ module PacketGen
         def mcast?
           self.a1 & 0xff00 == 0xff00
         end
+
+        def ==(other)
+          other.is_a?(self.class) &&
+            fields.all? { |attr| self[attr].value == other[attr].value }
+        end
       end
 
       # Class to handle series of IPv6 addresses

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

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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 IPv6

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

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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 IPv6
@@ -106,7 +106,7 @@ module PacketGen
         # @!attribute options
         #  Specific options of extension header
         #  @return [Options]
-        define_field_before :body, :options, Options, builder: ->(h, t) { t.new(length_from: -> { h.real_length - 2} ) }
+        define_field_before :body, :options, Options, builder: ->(h, t) { t.new(length_from: -> { h.real_length - 2 }) }
       end
     end
 

data/lib/packetgen/header/llc.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
     # Logical-Link Control header

data/lib/packetgen/header/mdns.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # 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
     # Multicast DNS.

data/lib/packetgen/header/mld.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
     # This class supports MLDv1 (RFC 2710).

data/lib/packetgen/header/mldv2.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
     # This module contains all MLDv2 specific classes.

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

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
     module MLDv2
@@ -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/mldv2/mlq.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
     module MLDv2

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

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
-
 require_relative 'mcast_address_record'
 
 module PacketGen

data/lib/packetgen/header/ospfv2.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # 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
     # This class supports OSPFv2 (RFC 2328).
@@ -75,18 +75,18 @@ module PacketGen
 
       # OSPF packet types
       TYPES = {
-        'HELLO'          => 1,
+        'HELLO' => 1,
         'DB_DESCRIPTION' => 2,
-        'LS_REQUEST'     => 3,
-        'LS_UPDATE'      => 4,
-        'LS_ACK'         => 5
+        'LS_REQUEST' => 3,
+        'LS_UPDATE' => 4,
+        'LS_ACK' => 5
       }.freeze
 
       # Authentication types
       AU_TYPES = {
-        'NO_AUTH'         => 0,
-        'PASSWORD'        => 1,
-        'CRYPTO'          => 2,
+        'NO_AUTH' => 0,
+        'PASSWORD' => 1,
+        'CRYPTO' => 2,
         'CRYPTO_WITH_ESN' => 3
       }.freeze