packetgen 2.6.0 → 2.7.0

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

@@ -36,20 +36,20 @@ module PacketGen
       #
       # @author Kent 'picat' Gruber
       class Response < Base
-        # @!attribute version 
+        # @!attribute version
         #   @return [Types::String]
-        define_field :version,     Types::String, default: "HTTP/1.1"
-        # @!attribute status_code 
+        define_field :version,     Types::String, default: 'HTTP/1.1'
+        # @!attribute status_code
         #   @return [Types::String]
         define_field :status_code, Types::String
-        # @!attribute status_mesg 
+        # @!attribute status_mesg
         #   @return [Types::String]
-        define_field :status_mesg, Types::String  
+        define_field :status_mesg, Types::String
         # @!attribute headers
         #   associated http/1.1 headers
         #   @return [Types::String]
         define_field :headers, HTTP::Headers
-        # @!attribute body 
+        # @!attribute body
         #   @return [HTTP::PHeaders]
         define_field :body, Types::String
 
@@ -64,7 +64,7 @@ module PacketGen
           self.headers ||= options[:headers]
         end
 
-        # Read in the HTTP portion of the packet, and parse it. 
+        # Read in the HTTP portion of the packet, and parse it.
         # @return [PacketGen::HTTP::Response]
         def read(str)
           str = str.bytes.map!(&:chr).join unless str.valid_encoding?
@@ -89,8 +89,8 @@ module PacketGen
             first_line = headers.shift.split
             self[:version]     = first_line[0]
             self[:status_code] = first_line[1]
-            self[:status_mesg] = first_line[2..-1].join(" ")
-            self[:headers].read(headers.join("\n")) 
+            self[:status_mesg] = first_line[2..-1].join(' ')
+            self[:headers].read(headers.join("\n"))
           end
           self[:body] = data.join("\n")
           self
@@ -99,20 +99,18 @@ module PacketGen
         # String representation of data.
         # @return [String]
         def to_s
-          raise FormatError, "Missing #status_code." if self.status_code.empty?
-          raise FormatError, "Missing #status_mesg." if self.status_mesg.empty?
-          raise FormatError, "Missing #version."     if self.version.empty? 
-          str = "".dup # build 'dat string
-          str << self[:version] << " " << self[:status_code] << " " << self[:status_mesg] << "\r\n" 
-          if self[:headers].given?
-            str << self[:headers].to_s 
-          end
+          raise FormatError, 'Missing #status_code.' if self.status_code.empty?
+          raise FormatError, 'Missing #status_mesg.' if self.status_mesg.empty?
+          raise FormatError, 'Missing #version.'     if self.version.empty?
+          str = ''.dup # build 'dat string
+          str << self[:version] << ' ' << self[:status_code] << ' ' << self[:status_mesg] << "\r\n"
+          str << self[:headers].to_s if self[:headers].given?
           str << self.body
         end
       end
     end
 
     self.add_class HTTP::Response
-    TCP.bind_header HTTP::Response, body: ->(b) { /^HTTP\/1\.1\s\d{3,}\s.+/ =~ b.chars.select(&:valid_encoding?).join }
+    TCP.bind HTTP::Response, body: ->(b) { %r[^HTTP/1\.1\s\d{3,}\s.+] =~ b.chars.select(&:valid_encoding?).join }
   end
 end

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

@@ -8,15 +8,15 @@
 module PacketGen
   module Header
     # @since 2.2.0
-    module HTTP 
+    module HTTP
       # @abstract Collection of useful HTTP verbs.
       # @author Kent 'picat' Gruber
-      
+
       # Valid HTTP Verbs
-      VERBS = ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'TRACE', 'PATCH'] 
-      
+      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/icmp.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # A ICMP header consists of:
     # * a {#type} field ({Types::Int8} type),
     # * a {#code} field ({Types::Int8} type),
@@ -29,7 +28,6 @@ module PacketGen
     #  icmp.body.read 'this is a body'
     # @author Sylvain Daubert
     class ICMP < Base
-
       # ICMP internet protocol number
       IP_PROTOCOL = 1
 
@@ -59,6 +57,6 @@ module PacketGen
 
     self.add_class ICMP
 
-    IP.bind_header ICMP, protocol: ICMP::IP_PROTOCOL
+    IP.bind ICMP, protocol: ICMP::IP_PROTOCOL
   end
 end

data/lib/packetgen/header/icmpv6.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # A ICMPv6 header consists of:
     # * a +type+ field ({Types::Int8} type),
     # * a +code+ field ({Types::Int8} type),
@@ -29,7 +28,6 @@ module PacketGen
     #  icmpv6.body.read 'this is a body'
     # @author Sylvain Daubert
     class ICMPv6 < ICMP
-
       # ICMPv6 internet protocol number
       IP_PROTOCOL = 58
 
@@ -45,6 +43,6 @@ module PacketGen
     end
 
     self.add_class ICMPv6
-    IPv6.bind_header ICMPv6, next: ICMPv6::IP_PROTOCOL
+    IPv6.bind ICMPv6, next: ICMPv6::IP_PROTOCOL
   end
 end

data/lib/packetgen/header/igmp.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # This class supports IGMPv2 (RFC 2236).
     #
     # From RFC 2236, a IGMP header has the following format:
@@ -40,18 +39,18 @@ module PacketGen
     #  icmp.checksum = 0x248a
     #  icmp.group_addr = '224.0.0.1'
     # @author Sylvain Daubert
+    # @since 2.4.0
     class IGMP < Base
-
       # IGMP internet protocol number
       IP_PROTOCOL = 2
-      
+
       # Known types
       TYPES = {
         'MembershipQuery'    => 0x11,
         'MembershipReportv1' => 0x12,
         'MembershipReportv2' => 0x16,
         'LeaveGroup'         => 0x17,
-      }
+      }.freeze
 
       # @!attribute type
       #  8-bit IGMP Type
@@ -113,7 +112,7 @@ module PacketGen
     end
 
     self.add_class IGMP
-    IP.bind_header IGMP, op: :and, protocol: IGMP::IP_PROTOCOL, frag: 0, ttl: 1,
-                   tos: ->(v) { v.nil? ? 0 : v != 0xc0 }
+    IP.bind IGMP, protocol: IGMP::IP_PROTOCOL, frag: 0, ttl: 1,
+                  tos: ->(v) { v.nil? ? 0 : v != 0xc0 }
   end
 end

data/lib/packetgen/header/igmpv3.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # This class supports IGMPv3 (RFC3376).
     #
     # From RFC 3376, a IGMP header has the following format:
@@ -63,17 +62,15 @@ module PacketGen
     #   pkt.igmpv3      #=> PacketGen::Header::IGMPv3
     #   pkt.igmpv3_mr  #=> PacketGen::Header::IGMPv3::MR
     # @author Sylvain Daubert
+    # @since 2.4.0
     class IGMPv3 < IGMP
-
       # Known types
       TYPES = {
         'MembershipQuery'  => 0x11,
         'MembershipReport' => 0x22,
-      }
+      }.freeze
 
       delete_field :group_addr
-      #undef group_addr
-      #undef group_addr=
 
       # Encode value for IGMPv3 Max Resp Code and QQIC.
       # Value may be encoded as a float, so some error may occur.
@@ -83,12 +80,12 @@ module PacketGen
       def self.encode(value)
         if value < 128
           value
-        elsif value > 31743
+        elsif value > 31_743
           255
         else
           exp = 0
           value >>= 3
-          while value > 31 do
+          while value > 31
             exp += 1
             value >>= 1
           end
@@ -134,8 +131,7 @@ module PacketGen
     end
 
     self.add_class IGMPv3
-    IP.bind_header IGMPv3, op: :and, protocol: IGMPv3::IP_PROTOCOL, frag: 0, ttl: 1,
-                   tos: 0xc0
+    IP.bind IGMPv3, protocol: IGMPv3::IP_PROTOCOL, frag: 0, ttl: 1, tos: 0xc0
   end
 end
 

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

@@ -40,7 +40,6 @@ module PacketGen
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
       class GroupRecord < Types::Fields
-
         # Known record types
         RECORD_TYPES = {
           'MODE_IS_INCLUDE'        => 1,
@@ -49,7 +48,7 @@ module PacketGen
           'CHANGE_TO_EXCLUDE_MODE' => 4,
           'ALLOW_NEW_SOURCES'      => 5,
           'BLOCK_OLD_SOURCES'      => 6
-        }
+        }.freeze
 
         # @!attribute type
         #  8-bit record type
@@ -76,7 +75,7 @@ module PacketGen
         # @!attribute aux_data
         #  @return [String]
         define_field :aux_data, Types::String,
-                     builder: ->(h, t) { t.new(length_from: ->() { h[:aux_data_len].to_i * 4 }) }
+                     builder: ->(h, t) { t.new(length_from: -> { h[:aux_data_len].to_i * 4 }) }
 
         def human_type
           self[:type].to_human
@@ -86,12 +85,12 @@ module PacketGen
           "#{human_type}(ma:#{multicast_addr}|src:#{source_addr.to_human})"
         end
       end
-      
+
       # Class to handle series of {GroupRecord}.
       # @author Sylvain Daubert
       class GroupRecords < Types::Array
         set_of GroupRecord
-        
+
         # Separator used in {#to_human}.
         HUMAN_SEPARATOR = ';'
       end

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

@@ -61,7 +61,7 @@ module PacketGen
         #  Array of IP source addresses
         #  @return [IP::ArrayOfAddr]
         define_field :source_addr, IP::ArrayOfAddr,
-                     builder: ->(h,t) { t.new(counter: h[:number_of_sources]) }
+                     builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
 
         # @!attribute resv
         #  4-bit reserved field in
@@ -93,6 +93,6 @@ module PacketGen
     end
 
     self.add_class IGMPv3::MQ
-    IGMPv3.bind_header IGMPv3::MQ, type: 0x11
+    IGMPv3.bind IGMPv3::MQ, type: 0x11
   end
 end

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

@@ -4,6 +4,7 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require_relative 'group_record'
 
 module PacketGen
@@ -12,7 +13,7 @@ module PacketGen
       # IGMPv3 Membership Report.
       #
       # This is a subpayload for IGMPv3 packets only. This kind of payload is
-      # sent by IP systems to report (to neighboring routers) the current multicast 
+      # sent by IP systems to report (to neighboring routers) the current multicast
       # reception state, or changes in the multicast reception state, of their
       # interfaces. Reports have the following format:
       #    0                   1                   2                   3
@@ -52,7 +53,7 @@ module PacketGen
         #  16-bit Number of group records in {#group_records}
         #  @return [Integer]
         define_field :number_of_gr, Types::Int16, default: 0
-        
+
         # @!attribute group_records
         #  Array of group records
         #  @return [GroupRecords]
@@ -62,6 +63,6 @@ module PacketGen
     end
 
     self.add_class IGMPv3::MR
-    IGMPv3.bind_header IGMPv3::MR, type: 0x22
+    IGMPv3.bind IGMPv3::MR, type: 0x22
   end
 end

data/lib/packetgen/header/ike.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # This class handles a pseudo-header used to differentiate ESP from IKE headers
     # in a UDP datagram with port 4500.
     # @author Sylvain Daubert
@@ -24,7 +23,7 @@ module PacketGen
       # Check non_esp_marker field
       # @see [Base#parse?]
       def parse?
-        non_esp_marker == 0
+        non_esp_marker.zero?
       end
     end
 
@@ -75,7 +74,6 @@ module PacketGen
     # @author Sylvain Daubert
     # @since 2.0.0
     class IKE < Base
-
       # Classical well-known UDP port for IKE
       UDP_PORT1 = 500
       # Well-known UDP port for IKE when NAT is detected
@@ -182,7 +180,7 @@ module PacketGen
       def payloads
         payloads = []
         body = self.body
-        while body.is_a?(Payload) do
+        while body.is_a?(Payload)
           payloads << body
           body = body.body
         end
@@ -197,7 +195,7 @@ module PacketGen
           case attr
           when :flags
             str_flags = ''.dup
-            %w(r v i).each do |flag|
+            %w[r v i].each do |flag|
               str_flags << (send("flag_#{flag}?") ? flag.upcase : '.')
             end
             str << Inspect.shift_level(2)
@@ -213,14 +211,41 @@ module PacketGen
         end
         str
       end
+
+      # Toggle +I+ and +R+ flags.
+      # @return [self]
+      def reply!
+        self.flag_r = !self.flag_r?
+        self.flag_i = !self.flag_i?
+        self
+      end
+
+      # @api private
+      # @note This method is used internally by PacketGen and should not be
+      #       directly called
+      # @param [Packet] packet
+      # @return [void]
+      # @since 2.7.0 Set UDP sport according to bindings, only if sport is 0.
+      #  Needed by new bind API.
+      def added_to_packet(packet)
+        return unless packet.is? 'UDP'
+        return unless packet.udp.sport.zero?
+        packet.udp.sport = if packet.is?('NonESPMarker')
+                             UDP_PORT2
+                           else
+                             UDP_PORT1
+                           end
+      end
     end
 
     self.add_class IKE
     self.add_class NonESPMarker
 
-    UDP.bind_header IKE, dport: IKE::UDP_PORT1, sport: IKE::UDP_PORT1
-    UDP.bind_header NonESPMarker, dport: IKE::UDP_PORT2, sport: IKE::UDP_PORT2
-    NonESPMarker.bind_header IKE
+    UDP.bind IKE, dport: IKE::UDP_PORT1
+    UDP.bind IKE, sport: IKE::UDP_PORT1
+    UDP.bind NonESPMarker, dport: IKE::UDP_PORT2
+    UDP.bind NonESPMarker, sport: IKE::UDP_PORT2
+    NonESPMarker.bind IKE
   end
 end
 

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

@@ -9,7 +9,6 @@
 module PacketGen
   module Header
     class IKE
-
       # This class handles Authentication payloads.
       #
       # A AUTH payload consists of the IKE generic payload header (see {Payload})
@@ -36,7 +35,6 @@ module PacketGen
       #   pkt.calc_length
       # @author Sylvain Daubert
       class Auth < Payload
-
         # Payload type number
         PAYLOAD_TYPE = 39
 
@@ -50,7 +48,7 @@ module PacketGen
           'PASSWORD'          => 12,
           'NULL'              => 13,
           'DIGITAL_SIGNATURE' => 14
-        }
+        }.freeze
 
         # @attribute [r] method
         #   8-bit Auth Method
@@ -137,9 +135,9 @@ module PacketGen
           when Transform::PRF_HMAC_MD5, Transform::PRF_HMAC_SHA1,
                Transform::PRF_HMAC_SHA2_256, Transform::PRF_HMAC_SHA2_384,
                Transform::PRF_HMAC_SHA2_512
-            digestname = Transform.constants.grep(/PRF_/).
-                         detect { |c| Transform.const_get(c) == type }.
-                         to_s.sub(/^PRF_HMAC_/, '').sub(/2_/, '')
+            digestname = Transform.constants.grep(/PRF_/)
+                                  .detect { |c| Transform.const_get(c) == type }
+                                  .to_s.sub(/^PRF_HMAC_/, '').sub(/2_/, '')
             digest = OpenSSL::Digest.const_get(digestname).new
           else
             raise NotImplementedError, 'for now, only HMAC-based PRF are supported'