packetgen 2.6.0 → 2.7.0

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class IKE
-
       # Transform attribute.
       #                        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
@@ -24,7 +23,6 @@ module PacketGen
       # or a TV format (AF=1).
       # @author Sylvain Daubert
       class Attribute < Types::Fields
-
         TYPE_KEY_LENGTH = 14
 
         # @!attribute type
@@ -82,8 +80,8 @@ module PacketGen
         # Get a human readable string
         # @return [String]
         def to_human
-          name = self.class.constants.grep(/TYPE_/).
-                  detect { |c| self.class.const_get(c) == (type & 0x7fff) } || "attr[#{type & 0x7fff}]"
+          name = self.class.constants.grep(/TYPE_/)
+                     .detect { |c| self.class.const_get(c) == (type & 0x7fff) } || "attr[#{type & 0x7fff}]"
           name = name.to_s.sub(/TYPE_/, '')
           "#{name}=#{value}"
         end
@@ -127,7 +125,6 @@ module PacketGen
       #  trans.attributes << { type: 14, value: 128 }
       # @author Sylvain Daubert
       class Transform < Types::Fields
-
         TYPES = {
           'ENCR' => 1,
           'PRF'  => 2,
@@ -281,14 +278,14 @@ module PacketGen
         # @return [String]
         def to_human
           h = "#{human_type}(#{human_id}".dup
-          h << ",#{attributes.to_human}" if attributes.size > 0
+          h << ",#{attributes.to_human}" unless attributes.empty?
           h << ')'
         end
 
         # Get human-readable type
         # @return [String]
         def human_type
-          if self[:type].enum.has_value? self.type
+          if self[:type].enum.value? self.type
             self[:type].to_human
           else
             "type[#{self.type}]"
@@ -298,9 +295,9 @@ module PacketGen
         # Get human-readable ID
         # @return [String]
         def human_id
-          name = self.class.constants.grep(/#{human_type}_/).
-                 detect { |c| self.class.const_get(c) == id } || "ID=#{id}"
-           name.to_s.sub(/#{human_type}_/, '')
+          name = self.class.constants.grep(/#{human_type}_/)
+                     .detect { |c| self.class.const_get(c) == id } || "ID=#{id}"
+          name.to_s.sub(/#{human_type}_/, '')
         end
 
         # Say if this transform is the last one (from {#last} field)
@@ -311,8 +308,6 @@ module PacketGen
             true
           when 3
             false
-          else
-            nil
           end
         end
       end
@@ -360,7 +355,6 @@ module PacketGen
       #  proposal.transforms << { type: 'ENCR', id: '3DES' }
       # @author Sylvain Daubert
       class SAProposal < Types::Fields
-
         # @!attribute last
         #  8-bit last substructure. Specifies whether or not this is the
         #  last Proposal Substructure in the SA. This field has a value of 0
@@ -410,7 +404,7 @@ module PacketGen
         define_field :transforms, Transforms, builder: ->(h, t) { t.new(counter: h[:num_trans]) }
 
         def initialize(options={})
-          if options[:spi] and options[:spi_size].nil?
+          if options[:spi] && options[:spi_size].nil?
             options[:spi_size] = options[:spi].size
           end
           super
@@ -423,12 +417,12 @@ module PacketGen
         # @return [Integer]
         def protocol=(value)
           proto = case value
-               when Integer
-                 value
-               else
-                 c = IKE.constants.grep(/PROTO_#{value}/).first
-                 c ? IKE.const_get(c) : nil
-               end
+                  when Integer
+                    value
+                  else
+                    c = IKE.constants.grep(/PROTO_#{value}/).first
+                    c ? IKE.const_get(c) : nil
+                  end
           raise ArgumentError, "unknown protocol #{value.inspect}" unless proto
           self[:protocol].value = proto
         end
@@ -447,7 +441,7 @@ module PacketGen
         # Compute length and set {#length} field
         # @return [Integer] new length
         def calc_length
-          transforms.each { |t| t.calc_length }
+          transforms.each(&:calc_length)
           Base.calculate_and_set_length self
         end
 
@@ -457,9 +451,9 @@ module PacketGen
           str = "##{num} #{human_protocol}".dup
           case spi_size
           when 4
-            str << "(spi:0x%08x)" % Types::Int32.new.read(spi).to_i
+            str << '(spi:0x%08x)' % Types::Int32.new.read(spi).to_i
           when 8
-            str << "(spi:0x%016x)" % Types::Int64.new.read(spi).to_i
+            str << '(spi:0x%016x)' % Types::Int64.new.read(spi).to_i
           end
           str << ":#{transforms.to_human}"
         end
@@ -467,8 +461,8 @@ module PacketGen
         # Get protocol name
         # @return [String]
         def human_protocol
-          name = IKE.constants.grep(/PROTO/).
-                 detect { |c| IKE.const_get(c) == protocol } || "proto #{protocol}"
+          name = IKE.constants.grep(/PROTO/)
+                    .detect { |c| IKE.const_get(c) == protocol } || "proto #{protocol}"
           name.to_s.sub(/PROTO_/, '')
         end
 
@@ -481,8 +475,6 @@ module PacketGen
             true
           when 2
             false
-          else
-            nil
           end
         end
       end
@@ -533,7 +525,6 @@ module PacketGen
       #   pkt.calc_length
       # @author Sylvain Daubert
       class SA < Payload
-
         # Payload type number
         PAYLOAD_TYPE = 33
 
@@ -553,14 +544,14 @@ module PacketGen
           hlen = self.class.new.sz
           plen = length - hlen
           proposals.read str[hlen, plen]
-          body.read str[hlen+plen..-1]
+          body.read str[hlen + plen..-1]
           self
         end
 
         # Compute length and set {#length} field
         # @return [Integer] new length
         def calc_length
-          proposals.each { |p| p.calc_length }
+          proposals.each(&:calc_length)
           super
         end
       end

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class IKE
-
       # This class handles encrypted payloads, denoted SK.
       #
       # The encrypted payload contains other payloads in encrypted form.
@@ -114,15 +113,15 @@ module PacketGen
           cipher.iv = real_iv
 
           if authenticated?
-            if @icv_length == 0
+            if @icv_length.zero?
               @icv_length = opt[:icv_length].to_i if opt[:icv_length]
-              raise ParseError, 'unknown ICV size' if @icv_length == 0
+              raise ParseError, 'unknown ICV size' if @icv_length.zero?
             end
             icv = self.content.slice!(-@icv_length, @icv_length)
           end
 
-          authenticate_if_needed opt, iv, icv
-          private_decrypt cipher, opt
+          authenticate_if_needed iv, icv
+          private_decrypt opt
         end
 
         # Encrypt in-place SK payload.
@@ -151,14 +150,14 @@ module PacketGen
           real_iv += [1].pack('N') if confidentiality_mode == 'ctr'
           cipher.iv = real_iv
 
-          authenticate_if_needed options, iv
+          authenticate_if_needed iv
 
           if opt[:pad_length]
             pad_length = opt[:pad_length]
             padding = force_binary(opt[:padding] || ([0] * pad_length).pack('C*'))
           else
             pad_length = cipher.block_size
-            pad_length = 16 if cipher.block_size == 1  # Some AES mode returns 1...
+            pad_length = 16 if cipher.block_size == 1 # Some AES mode returns 1...
             pad_length -= (self.body.sz + iv.size + 1) % cipher.block_size
             pad_length = 0 if pad_length == 16
             padding = force_binary(opt[:padding] || ([0] * pad_length).pack('C*'))
@@ -170,13 +169,13 @@ module PacketGen
 
           if authenticated?
             @icv_length = opt[:icv_length] if opt[:icv_length]
-            if @conf.authenticated?
-              encrypted_msg << @conf.auth_tag[0, @icv_length]
-            else
-              encrypted_msg << @intg.digest[0, @icv_length]
-            end
+            encrypted_msg << if @conf.authenticated?
+                               @conf.auth_tag[0, @icv_length]
+                             else
+                               @intg.digest[0, @icv_length]
+                             end
           end
-          self[:content].read (iv + encrypted_msg)
+          self[:content].read(iv + encrypted_msg)
 
           # Remove plain payloads
           self[:body] = Types::String.new
@@ -184,7 +183,7 @@ module PacketGen
           # Remove enciphered payloads from packet
           id = header_id(self)
           if id < packet.headers.size - 1
-            (packet.headers.size-1).downto(id+1) do |index|
+            (packet.headers.size - 1).downto(id + 1) do |index|
               packet.headers.delete_at index
             end
           end
@@ -195,7 +194,7 @@ module PacketGen
 
         private
 
-        def authenticate_if_needed(options, iv, icv=nil)
+        def authenticate_if_needed(iv, icv=nil)
           if @conf.authenticated?
             @conf.auth_tag = icv if icv
             @conf.auth_data = get_ad
@@ -216,14 +215,14 @@ module PacketGen
         def get_ad
           str = packet.ike.to_s[0, IKE.new.sz]
           current_payload = packet.ike.body
-          until current_payload.is_a? SK do
+          until current_payload.is_a? SK
             str << current_payload.to_s[0, current_payload.length]
             current_payload = current_payload.body
           end
           str << self.to_s[0, SK.new.sz]
         end
 
-        def private_decrypt(cipher, options)
+        def private_decrypt(options)
           # decrypt
           plain_msg = decipher(content.to_s)
           # Remove cipher text

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class IKE
-
       # TrafficSelector substructure, as defined in RFC 7296, §3.13.1:
       #                        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
@@ -52,7 +51,7 @@ module PacketGen
         # @!attribute end_port
         #  16-bit End port
         #  @return [Integer]
-        define_field :end_port, Types::Int16, default: 65535
+        define_field :end_port, Types::Int16, default: 65_535
         # @!attribute start_addr
         #  starting address
         #  @return [IP::Addr, IPv6::Addr]
@@ -74,10 +73,10 @@ module PacketGen
           self[:length].value = sz unless options[:length]
           self.type = options[:type] if options[:type]
           self.protocol = options[:protocol] if options[:protocol]
-          if options[:ports]
-            self.start_port = options[:ports].begin
-            self.end_port = options[:ports].end
-          end
+
+          return unless options[:ports]
+          self.start_port = options[:ports].begin
+          self.end_port = options[:ports].end
         end
 
         # Populate object from a string
@@ -94,12 +93,12 @@ module PacketGen
         # @return [Integer]
         def type=(value)
           type = case value
-               when Integer
-                 value
-               else
-                 c = self.class.constants.grep(/TS_#{value.upcase}/).first
-                 c ? self.class.const_get(c) : nil
-               end
+                 when Integer
+                   value
+                 else
+                   c = self.class.constants.grep(/TS_#{value.upcase}/).first
+                   c ? self.class.const_get(c) : nil
+                 end
           raise ArgumentError, "unknown type #{value.inspect}" unless type
           select_addr_from_type type
           self[:type].value = type
@@ -110,11 +109,11 @@ module PacketGen
         # @return [Integer]
         def protocol=(value)
           protocol = case value
-                when Integer
-                 value
-               else
-                 Proto.getprotobyname(value)
-               end
+                     when Integer
+                       value
+                     else
+                       Proto.getprotobyname(value)
+                     end
           raise ArgumentError, "unknown protocol #{value.inspect}" unless protocol
           self[:protocol].value = protocol
         end
@@ -125,7 +124,7 @@ module PacketGen
           h = start_addr << '-' << end_addr
           unless human_protocol.empty?
             h << "/#{human_protocol}"
-            h << "[#{start_port}-#{end_port}]" if (start_port..end_port) != (0..65535)
+            h << "[#{start_port}-#{end_port}]" if (start_port..end_port) != (0..65_535)
           end
           h
         end
@@ -134,10 +133,10 @@ module PacketGen
         # is returned.
         # @return [String]
         def human_protocol
-          if protocol == 0
+          if protocol.zero?
             ''
           else
-            Proto.getprotobynumber(protocol) || "#{protocol}"
+            Proto.getprotobynumber(protocol) || protocol.to_s
           end
         end
 
@@ -218,7 +217,6 @@ module PacketGen
       #  pkt.ike_tsi.traffic_selectors << { start_addr: '2001::1', end_addr: '200a:ffff:ffff:ffff:ffff:ffff:ffff:ffff' }
       # @author Sylvain Daubert
       class TSi < Payload
-
         # Payload type number
         PAYLOAD_TYPE = 44
 
@@ -239,7 +237,7 @@ module PacketGen
         #  @return {TrafficSelectors}
         define_field_before :body, :traffic_selectors, TrafficSelectors,
                             builder: ->(h, t) { t.new(counter: h[:num_ts]) }
-        alias :selectors :traffic_selectors
+        alias selectors traffic_selectors
 
         # Populate object from a string
         # @param [String] str
@@ -249,14 +247,14 @@ module PacketGen
           hlen = self.class.new.sz
           tslen = length - hlen
           selectors.read str[hlen, tslen]
-          body.read str[hlen+tslen..-1]
+          body.read str[hlen + tslen..-1]
           self
         end
 
         # Compute length and set {#length} field
         # @return [Integer] new length
         def calc_length
-          selectors.each { |p| p.calc_length }
+          selectors.each(&:calc_length)
           super
         end
       end

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class IKE
-
       # This class handles Vendor ID payloads, as defined in RFC 7296 §3.12.
       #
       # A Vendor ID payload contains a generic payload header (see {Payload})
@@ -30,7 +29,6 @@ module PacketGen
       #   pkt.add('IKE::VendorID', data: "abcdefgh")
       # @author Sylvain Daubert
       class VendorID < Payload
-
         # Payload type number
         PAYLOAD_TYPE = 43
       end

data/lib/packetgen/header/ip.rb

@@ -4,11 +4,11 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'socket'
 
 module PacketGen
   module Header
-
     # A IP header consists of:
     # * a first byte ({#u8} of {Types::Int8} type) composed of:
     #   * a 4-bit {#version} field,
@@ -62,14 +62,13 @@ module PacketGen
     #  ip.dst = '127.0.0.2'
     #  ip.body.read 'this is a body'
     # @author Sylvain Daubert
-    class IP < Base;end
+    class IP < Base; end
 
-require_relative 'ip/addr'
-require_relative 'ip/option'
-require_relative 'ip/options'
+    require_relative 'ip/addr'
+    require_relative 'ip/option'
+    require_relative 'ip/options'
 
     class IP
-
       # IP Ether type
       ETHERTYPE = 0x0800
 
@@ -85,7 +84,7 @@ require_relative 'ip/options'
       define_field :length, Types::Int16, default: 20
       # @!attribute id
       #   @return [Integer] 16-bit ID
-      define_field :id, Types::Int16, default: -> { rand(65535) }
+      define_field :id, Types::Int16, default: -> { rand(65_535) }
       # @!attribute frag
       #   @return [Integer] 16-bit frag word
       define_field :frag, Types::Int16, default: 0
@@ -111,7 +110,7 @@ require_relative 'ip/options'
       # @!attribute body
       #  @return [Types::String,Header::Base]
       define_field :body, Types::String
-      
+
       # @!attribute version
       #   @return [Integer] 4-bit version attribute
       # @!attribute ihl
@@ -121,7 +120,7 @@ require_relative 'ip/options'
       # @!attribute flag_rsv
       #   @return [Boolean] reserved bit from flags
       # @!attribute flag_df
-      #   @return [Boolean] Don't Fragment flag 
+      #   @return [Boolean] Don't Fragment flag
       # @!attribute flag_mf
       #   @return [Boolean] More Fragment flags
       # @!attribute fragment_offset
@@ -133,7 +132,7 @@ require_relative 'ip/options'
       # @param [#to_s] hdr header or other object on which calculates a sum
       #   of 16-bit words.
       # @return [Integer]
-      def IP.sum16(hdr)
+      def self.sum16(hdr)
         old_checksum = nil
         if hdr.respond_to? :checksum=
           old_checksum = hdr.checksum
@@ -141,11 +140,11 @@ require_relative 'ip/options'
         end
 
         data = hdr.to_s
-        data << "\x00" if data.size % 2 == 1
+        data << "\x00" if data.size.odd?
         sum = data.unpack('n*').reduce(:+)
 
         hdr.checksum = old_checksum if old_checksum
-        
+
         sum
       end
 
@@ -157,12 +156,12 @@ require_relative 'ip/options'
       # * 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
+      def self.reduce_checksum(checksum)
+        while checksum > 0xffff
           checksum = (checksum & 0xffff) + (checksum >> 16)
         end
         checksum = ~checksum & 0xffff
-        (checksum == 0) ? 0xffff : checksum
+        checksum.zero? ? 0xffff : checksum
       end
 
       # Populate object from a binary string
@@ -186,7 +185,7 @@ require_relative 'ip/options'
           opt_size = (self.ihl - 5) * 4
           self[:options].read str[20, opt_size]
         end
-        self[:body].read str[20+opt_size..-1]
+        self[:body].read str[20 + opt_size..-1]
         self
       end
 
@@ -227,7 +226,7 @@ require_relative 'ip/options'
       # kernel, so bad IP packets cannot be sent this way. To do so, use {Eth#to_w}.
       # @param [String,nil] iface interface name. Not used
       # @return [void]
-      def to_w(iface=nil)
+      def to_w(_iface=nil)
         sock = Socket.new(Socket::AF_INET, Socket::SOCK_RAW, Socket::IPPROTO_RAW)
         sockaddrin = Socket.sockaddr_in(0, dst)
         sock.send to_s, 0, sockaddrin
@@ -245,7 +244,7 @@ require_relative 'ip/options'
             str << shift + Inspect::FMT_ATTR % ['', 'version', version]
             str << shift + Inspect::FMT_ATTR % ['', 'ihl', ihl]
           elsif attr == :frag
-            flags = flag_rsv? ? %w(RSV) : []
+            flags = flag_rsv? ? %w[RSV] : []
             flags << 'DF' if flag_df?
             flags << 'MF' if flag_mf?
             flags_str = flags.empty? ? 'none' : flags.join(',')
@@ -260,7 +259,7 @@ require_relative 'ip/options'
       # Check version field
       # @see [Base#parse?]
       def parse?
-        version == 4 and ihl >= 5
+        (version == 4) && (ihl >= 5)
       end
 
       # Get binary string. Fixup IHL if needed (IP header has options, and IHL
@@ -269,13 +268,21 @@ require_relative 'ip/options'
         self.ihl = 5 + options.sz / 4 if self.ihl == 5
         super
       end
+
+      # Invert source and destination addresses
+      # @return [self]
+      # @since 2.7.0
+      def reply!
+        self[:src], self[:dst] = self[:dst], self[:src]
+        self
+      end
     end
 
     self.add_class IP
 
-    Eth.bind_header IP, ethertype: IP::ETHERTYPE
-    SNAP.bind_header IP, proto_id: IP::ETHERTYPE
-    Dot1q.bind_header IP, ethertype: IP::ETHERTYPE
-    IP.bind_header IP, protocol: 4
+    Eth.bind IP, ethertype: IP::ETHERTYPE
+    SNAP.bind IP, proto_id: IP::ETHERTYPE
+    Dot1q.bind IP, ethertype: IP::ETHERTYPE
+    IP.bind IP, protocol: 4
   end
 end