packetgen 2.6.0 → 2.7.0

data/lib/packetgen/header/tcp.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # A TCP header consists of:
     # * a source port ({#sport}, {Types::Int16} type),
     # * a destination port ({#dport}, +Int16+ type),
@@ -147,8 +146,8 @@ module PacketGen
       # @!attribute flags
       #  @return [Integer] 9-bit flags from {#u16}
       define_bit_fields_on :u16, :data_offset, 4, :reserved, 3, :flags, 9
-      alias :hlen :data_offset
-      alias :hlen= :data_offset=
+      alias hlen data_offset
+      alias hlen= data_offset=
 
       # @!attribute flag_ns
       #  @return [Boolean] 1-bit NS flag
@@ -205,9 +204,6 @@ module PacketGen
         self[:data_offset] = 5 + self[:options].sz / 4
       end
 
-      alias hlen data_offset
-      alias hlen= data_offset=
-
       # @return [String]
       def inspect
         str = Inspect.dashed_line(self.class, 2)
@@ -220,7 +216,7 @@ module PacketGen
             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|
+            %w[ns cwr ece urg ack psh rst syn fin].each do |fl|
               flags << (send("flag_#{fl}?") ? fl[0].upcase : '.')
             end
             str << shift + Inspect::FMT_ATTR % ['', 'flags', flags]
@@ -228,11 +224,19 @@ module PacketGen
         end
         str
       end
+
+      # Invert source and destination port numbers
+      # @return [self]
+      # @since 2.7.0
+      def reply!
+        self[:sport], self[:dport] = self[:dport], self[:sport]
+        self
+      end
     end
 
     self.add_class TCP
 
-    IP.bind_header TCP, protocol: TCP::IP_PROTOCOL
-    IPv6.bind_header TCP, next: TCP::IP_PROTOCOL
+    IP.bind TCP, protocol: TCP::IP_PROTOCOL
+    IPv6.bind TCP, next: TCP::IP_PROTOCOL
   end
 end

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

@@ -8,11 +8,9 @@
 module PacketGen
   module Header
     class TCP
-
       # Base class to describe a TCP option
       # @author Sylvain Daubert
       class Option < Base
-
         # EOL option value
         EOL_KIND       = 0
         # NOP option value
@@ -53,9 +51,9 @@ module PacketGen
           case options[:value]
           when Integer
             klass = case self[:length].to_i
-                    when 3; Types::Int8
-                    when 4; Types::Int16
-                    when 6; Types::Int32
+                    when 3 then Types::Int8
+                    when 4 then Types::Int16
+                    when 6 then Types::Int32
                     else
                       raise ArgumentError, 'impossible length'
                     end
@@ -77,18 +75,25 @@ module PacketGen
           self[:kind].read str[0, 1]
           if str[1, 1]
             self[:length].read str[1, 1]
-            if str[2, 1] && length > 2
-              self[:value].read str[2, length - 2]
-            end
+            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]
-        def has_length?
+        # @since 2.7.0
+        def length?
           self[:kind].value && kind >= 2
         end
 
+        # @deprecated Use {#length?}.
+        # @return [Boolean]
+        def has_length?
+          Deprecation.deprecated(self.class, __method__, 'length?')
+          length?
+        end
+
         # Getter for value attribute
         # @return [String, Integer]
         def value
@@ -113,7 +118,7 @@ module PacketGen
         # @return [String]
         def to_human
           str = self.class == Option ? "unk-#{kind}" : self.class.to_s.sub(/.*::/, '')
-          if length > 2 and self[:value].to_s.size > 0
+          if (length > 2) && !self[:value].to_s.empty?
             str << ":#{self[:value].to_s.inspect}"
           end
           str
@@ -121,7 +126,7 @@ module PacketGen
 
         # @return [String]
         def inspect
-          str = "#<#{self.class} kind=#{self[:kind].value.inspect} "
+          str = +"#<#{self.class} kind=#{self[:kind].value.inspect} "
           str << "length=#{self[:length].value.inspect} " if self[:length].value
           str << "value=#{self[:value].inspect}>"
         end

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

@@ -8,11 +8,9 @@
 module PacketGen
   module Header
     class TCP
-
       # Container for TCP options in {TCP TCP header}.
       # @author Sylvain Daubert
       class Options < Types::Array
-
         # Get {Option} subclasses
         # @return [Array<Class>]
         def self.option_classes
@@ -44,7 +42,7 @@ module PacketGen
                             klasses[kind].new
                           end
             this_option.read str[i, str.size]
-            unless this_option.has_length?
+            unless this_option.length?
               this_option.length = nil
               this_option.value = nil
             end
@@ -61,6 +59,7 @@ module PacketGen
         # @return [self]
         # @raise [ArgumentError] unknown option
         def add(opt, value=nil)
+          Deprecation.deprecated(self.class, __method__, 'push')
           option = record_from_hash(opt: opt, value: value)
           self << option
           self
@@ -69,7 +68,7 @@ module PacketGen
         private
 
         def record_from_hash(hsh)
-          if hsh.has_key? :opt
+          if hsh.key? :opt
             klassname = hsh.delete(:opt)
             if TCP.const_defined?(klassname)
               klass = TCP.const_get(klassname)

data/lib/packetgen/header/tftp.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # A TFTP (Trivial File Transfer Protocol,
     # {https://tools.ietf.org/html/rfc1350 RFC 1350}) header consists of:
     # * a {#opcode} ({Types::Int16Enum}),
@@ -46,8 +45,8 @@ module PacketGen
     #   packets[0].tftp.decode!(packets[1..-1])
     #   packets.map { |pkt| pkt.headers.last.class.to_s }.join(',')  # => TFTP::RRQ,TFTP::DATA,UDP,TFTP::ACK
     # @author Sylvain Daubert
+    # @since 2.3.0
     class TFTP < Base
-
       # Known opcodes
       OPCODES = {
         'RRQ'   => 1,
@@ -55,22 +54,22 @@ module PacketGen
         'DATA'  => 3,
         'ACK'   => 4,
         'Error' => 5
-      }
+      }.freeze
 
       # @!attribute opcode
       #   16-bit operation code
       #   @return [Integer]
       define_field :opcode, Types::Int16Enum, enum: OPCODES
-      
+
       # @!attribute body
       #   @return [String]
       define_field :body, Types::String
-      
+
       def initialize(options={})
         type = protocol_name.sub(/^.*::/, '')
         opcode = OPCODES[type]
-        if self.class != TFTP and !opcode.nil?
-          super({opcode: opcode}.merge(options))
+        if (self.class != TFTP) && !opcode.nil?
+          super({ opcode: opcode }.merge(options))
         else
           super
         end
@@ -85,7 +84,7 @@ module PacketGen
       def read(str)
         if self.instance_of? TFTP
           super
-          if OPCODES.values.include? opcode
+          if OPCODES.value? opcode
             TFTP.const_get(human_opcode).new.read str
           else
             self
@@ -94,7 +93,7 @@ module PacketGen
           old_read str
         end
       end
-      
+
       # Decode subsequent TFTP packets to this one. Packets are modified
       # in place in +ary+.
       # @param [Array<Packet>] ary
@@ -104,7 +103,7 @@ module PacketGen
         server_tid = nil
         ary.each do |pkt|
           if server_tid.nil?
-            next unless pkt.is?('UDP') and pkt.udp.dport == client_tid
+            next unless pkt.is?('UDP') && (pkt.udp.dport == client_tid)
             server_tid = pkt.udp.sport
           else
             next unless pkt.is?('UDP')
@@ -120,7 +119,7 @@ module PacketGen
         end
       end
 
-       # Get human readable opcode
+      # Get human readable opcode
       # @return [String]
       def human_opcode
         self[:opcode].to_human
@@ -132,16 +131,15 @@ module PacketGen
       # @param [Packet] packet
       # @return [void]
       def added_to_packet(packet)
-        unless packet.respond_to? :tftp
-          packet.instance_eval("def tftp(arg=nil); header(#{self.class}, arg); end")
-        end
+        return if packet.respond_to? :tftp
+        packet.instance_eval("def tftp(arg=nil); header(#{self.class}, arg); end")
       end
 
       # TFTP Read Request header
       class RRQ < TFTP
         delete_field :body
         undef body
-        
+
         # @!attribute filename
         #   Filename to access
         #   @return [String]
@@ -168,7 +166,7 @@ module PacketGen
       class ACK < TFTP
         delete_field :body
         undef body
-        
+
         # @!attribute block_num
         #   16-bit block number
         #   @return [Integer]
@@ -192,6 +190,6 @@ module PacketGen
         alias error_message error_msg
       end
     end
-    UDP.bind_header TFTP, dport: 69
+    UDP.bind TFTP, dport: 69
   end
 end

data/lib/packetgen/header/udp.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # A UDP header consists of:
     # * a source port field ({#sport}, {Types::Int16} type),
     # * a destination port field ({#dport}, +Int16+ type),
@@ -32,7 +31,6 @@ module PacketGen
     #
     # @author Sylvain Daubert
     class UDP < Base
-
       # IP protocol number for UDP
       IP_PROTOCOL = 17
 
@@ -84,11 +82,19 @@ module PacketGen
       def calc_length
         Base.calculate_and_set_length self
       end
+
+      # Invert source and destination port numbers
+      # @return [self]
+      # @since 2.7.0
+      def reply!
+        self[:sport], self[:dport] = self[:dport], self[:sport]
+        self
+      end
     end
 
     self.add_class UDP
 
-    IP.bind_header UDP, protocol: UDP::IP_PROTOCOL
-    IPv6.bind_header UDP, next: UDP::IP_PROTOCOL
+    IP.bind UDP, protocol: UDP::IP_PROTOCOL
+    IPv6.bind UDP, next: UDP::IP_PROTOCOL
   end
 end

data/lib/packetgen/inspect.rb

@@ -6,12 +6,10 @@
 # frozen_string_literal: true
 
 module PacketGen
-
   # {Inspect} module provides methods to help writing +inspect+
   # @api private
   # @author Sylvain Daubert
   module Inspect
-
     # Maximum number of characters on a line for INSPECT
     MAX_WIDTH = 70
 
@@ -53,7 +51,7 @@ module PacketGen
       str = shift_level(level)
       val = if value.is_a?(Types::Enum)
               "%-10s (0x%0#{value.sz * 2}x)" % [value.to_human, value.to_i]
-            elsif value.is_a?(Types::Int) or value.is_a?(Integer)
+            elsif value.is_a?(Types::Int) || value.is_a?(Integer)
               int_dec_hex(value, value.sz * 2)
             elsif value.is_a?(String)
               value.to_s.inspect
@@ -96,16 +94,16 @@ module PacketGen
     # @param [#to_s] body
     # @return [String]
     def self.inspect_body(body, name='Body')
-      return '' if body.nil? or body.empty?
+      return '' if body.nil? || body.empty?
       str = dashed_line(name, 2)
-      str << (0..15).to_a.map { |v| " %02d" % v}.join << "\n"
+      str << (0..15).to_a.map { |v| ' %02d' % v }.join << "\n"
       str << '-' * MAX_WIDTH << "\n"
-      if body.size > 0
+      unless body.empty?
         (body.size / 16 + 1).times do |i|
-          octets = body.to_s[i*16, 16].unpack('C*')
-          o_str = octets.map { |v| " %02x" % v}.join
+          octets = body.to_s[i * 16, 16].unpack('C*')
+          o_str = octets.map { |v| ' %02x' % v }.join
           str << o_str
-          str << ' ' * (3*16 - o_str.size) unless o_str.size >= 3*16
+          str << ' ' * (3 * 16 - o_str.size) unless o_str.size >= 3 * 16
           str << '  ' << octets.map { |v| v < 128 && v > 31 ? v.chr : '.' }.join
           str << "\n"
         end

data/lib/packetgen/packet.rb

@@ -5,10 +5,10 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'pcaprub'
 
 module PacketGen
-
   # An object of type {Packet} handles a network packet. This packet may contain
   # multiple protocol headers, starting from MAC layer or from Network (OSI) layer.
   #
@@ -107,17 +107,15 @@ module PacketGen
     # @author Sylvain Daubert
     # @author Kent Gruber
     def self.read(filename)
-      begin
-        PcapNG::File.new.read_packets filename
-      rescue => e
-        raise ArgumentError, e unless File.extname(filename.downcase) == '.pcap'
-        packets = []
-        PCAPRUB::Pcap.open_offline(filename).each_packet do |packet|
-          next unless packet = PacketGen.parse(packet.to_s)
-          packets << packet
-        end
-        packets
+      PcapNG::File.new.read_packets filename
+    rescue StandardError => e
+      raise ArgumentError, e unless File.extname(filename.downcase) == '.pcap'
+      packets = []
+      PCAPRUB::Pcap.open_offline(filename).each_packet do |packet|
+        next unless (packet = PacketGen.parse(packet.to_s))
+        packets << packet
       end
+      packets
     end
 
     # Write packets to +filename+
@@ -225,7 +223,7 @@ module PacketGen
     def to_f(filename)
       PcapNG::File.new.array_to_file(filename: filename, array: [self])
     end
-    alias :write :to_f
+    alias write to_f
 
     # send packet on wire. Use first header +#to_w+ method.
     # @param [String] iface interface name. Default to first non-loopback interface
@@ -277,9 +275,9 @@ module PacketGen
         raise FormatError, 'header not in packet!' if idx.nil?
 
         prev_header = idx > 0 ? @headers[idx - 1] : nil
-        next_header = (idx+1) < @headers.size ? @headers[idx + 1] : nil
+        next_header = (idx + 1) < @headers.size ? @headers[idx + 1] : nil
         @headers.delete_at(idx)
-        if prev_header and next_header
+        if prev_header && next_header
           add_header(next_header, previous_header: prev_header)
         end
       end
@@ -325,12 +323,32 @@ module PacketGen
       to_s == other.to_s
     end
 
+    # Invert all possible fields in packet to create a reply.
+    # @return [self]
+    def reply!
+      @headers.each do |header|
+        header.reply! if header.respond_to?(:reply!)
+      end
+      self
+    end
+
+    # Forge a new packet from current one with all possible fields
+    # inverted. The new packet may be a reply to current one.
+    # @return [Packet]
+    def reply
+      pkt = dup
+      pkt.reply!
+    end
+
     private
 
     # Dup +@headers+ instance variable. Internally used by +#dup+ and +#clone+
     # @return [void]
-    def initialize_copy(other)
-      @headers = @headers.dup
+    def initialize_copy(_other)
+      @headers = @headers.map(&:dup)
+      @headers.each do |header|
+        add_magic_header_method header
+      end
     end
 
     # @overload header(klass, layer=1)
@@ -386,15 +404,19 @@ module PacketGen
             raise ArgumentError, msg
           end
         end
-        bindings.set(prev_header) if !bindings.empty? and !parsing
+        bindings.set(prev_header) if !bindings.empty? && !parsing
         prev_header[:body] = header
       end
       header.packet = self
       @headers << header unless previous_header
-      unless respond_to? header.method_name
-        self.instance_eval "def #{header.method_name}(arg=nil);" \
-                           "header(#{header.class}, arg); end"
-      end
+
+      return if respond_to? header.method_name
+      add_magic_header_method header
+    end
+
+    def add_magic_header_method(header)
+      self.instance_eval "def #{header.method_name}(arg=nil);" \
+                         "header(#{header.class}, arg); end"
     end
 
     def guess_first_header(binary_str)
@@ -418,7 +440,7 @@ module PacketGen
 
     def decode_bottom_up
       decode_packet_bottom_up = true
-      while decode_packet_bottom_up do
+      while decode_packet_bottom_up
         last_known_hdr = @headers.last
         break unless last_known_hdr.respond_to? :body
         break if last_known_hdr.body.empty?