packetgen 2.6.0 → 2.7.0

data/lib/packetgen/pcapng.rb

@@ -4,15 +4,14 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'stringio'
 
 module PacketGen
-
   # Module to handle PCAP-NG file format.
   # See http://xml2rfc.tools.ietf.org/cgi-bin/xml2rfc.cgi?url=https://raw.githubusercontent.com/pcapng/pcapng/master/draft-tuexen-opsawg-pcapng.xml&modeAsFormat=html/ascii&type=ascii
   # @author Sylvain Daubert
   module PcapNG
-
     # Section Header Block type number
     SHB_TYPE = Types::Int32.new(0x0A0D0D0A, :little)
     # Interface Description Block type number
@@ -44,12 +43,9 @@ module PacketGen
     class Error < PacketGen::Error; end
     # Invalid PcapNG file error
     class InvalidFileError < Error; end
-
   end
-
 end
 
-
 require_relative 'pcapng/block.rb'
 require_relative 'pcapng/unknown_block.rb'
 require_relative 'pcapng/shb.rb'

data/lib/packetgen/pcapng/block.rb

@@ -7,11 +7,9 @@
 
 module PacketGen
   module PcapNG
-
     # @abstract Base class for all block types
     # @author Sylvain Daubert
     class Block < Types::Fields
-
       # @return [:little, :big]
       attr_accessor :endian
 
@@ -34,8 +32,16 @@ module PacketGen
 
       # Has this block option?
       # @return [Boolean]
+      # @since 2.7.0
+      def options?
+        @fields.key?(:options) && @fields[:options].sz > 0
+      end
+
+      # @deprecated Use {#options?} instead.
+      # @return [Boolean]
       def has_options?
-        @fields.has_key?(:options) && @fields[:options].sz > 0
+        Deprecation.deprecated(self.class, __method__, 'options?')
+        options?
       end
 
       # Calculate block length and update :block_len and block_len2 fields
@@ -50,7 +56,7 @@ module PacketGen
       # @return [void]
       def pad_field(*fields)
         fields.each do |field|
-          unless @fields[field].size % 4 == 0
+          unless (@fields[field].size % 4).zero?
             @fields[field] << "\x00" * (4 - (@fields[field].size % 4))
           end
         end
@@ -60,15 +66,15 @@ module PacketGen
 
       # Set the endianness for the various Int classes handled by self.
       # Must be called by all subclass #initialize method.
-      # @param [:little, :big] e
-      # @return [:little, :big] returns e
-      def set_endianness(e)
-        unless [:little, :big].include? e
+      # @param [:little, :big] endian
+      # @return [:little, :big] returns endian
+      def set_endianness(endian)
+        unless %i[little big].include? endian
           raise ArgumentError, "unknown endianness for #{self.class}"
         end
-        @endian = e
-        @fields.each { |f_, v| v.endian = e if v.is_a?(Types::Int) }
-        e
+        @endian = endian
+        @fields.each { |_f, v| v.endian = endian if v.is_a?(Types::Int) }
+        endian
       end
 
       def check_len_coherency

data/lib/packetgen/pcapng/epb.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module PcapNG
-
     # {EPB} represents a Enhanced Packet Block (EPB) of a pcapng file.
     #
     # == EPB Definition
@@ -23,9 +22,8 @@ module PacketGen
     #   Int32   :block_len2
     # @author Sylvain Daubert
     class EPB < Block
-
       # Minimum EPB size
-      MIN_SIZE     = 8*4
+      MIN_SIZE = 8 * 4
 
       # @return [:little, :big]
       attr_accessor :endian
@@ -84,11 +82,11 @@ module PacketGen
       # @param [::String,IO] str_or_io
       # @return [self]
       def read(str_or_io)
-        if str_or_io.respond_to? :read
-          io = str_or_io
-        else
-          io = StringIO.new(force_binary(str_or_io.to_s))
-        end
+        io = if str_or_io.respond_to? :read
+               str_or_io
+             else
+               StringIO.new(force_binary(str_or_io.to_s))
+             end
         return self if io.eof?
 
         self[:type].read io.read(4)
@@ -124,7 +122,6 @@ module PacketGen
         super
       end
 
-
       private
 
       def ts_resol
@@ -134,8 +131,6 @@ module PacketGen
           @interface.ts_resol
         end
       end
-
     end
-
   end
 end

data/lib/packetgen/pcapng/file.rb

@@ -7,11 +7,9 @@
 
 module PacketGen
   module PcapNG
-
     # PcapNG::File is a complete Pcap-NG file handler.
     # @author Sylvain Daubert
     class File
-
       # Known link types
       KNOWN_LINK_TYPES = {
         LINKTYPE_ETHERNET => 'Eth',
@@ -64,20 +62,17 @@ module PacketGen
         end
 
         ::File.open(fname, 'rb') do |f|
-          while !f.eof? do
-            parse_section(f)
-          end
+          parse_section(f) until f.eof?
         end
 
-        if blk
-          count = 0
-          @sections.each do |section|
-            section.interfaces.each do |intf|
-              intf.packets.each { |pkt| count += 1; yield pkt }
-            end
+        return unless blk
+        count = 0
+        @sections.each do |section|
+          section.interfaces.each do |intf|
+            intf.packets.each { |pkt| count += 1; yield pkt }
           end
-          count
         end
+        count
       end
 
       # Give an array of raw packets (raw data from packets).
@@ -143,7 +138,7 @@ module PacketGen
       # Return the object as a String
       # @return [String]
       def to_s
-        @sections.map { |section| section.to_s }.join
+        @sections.map(&:to_s).join
       end
 
       # Clear the contents of the Pcapng::File.
@@ -173,9 +168,9 @@ module PacketGen
         @sections.each do |section|
           section.interfaces.each do |itf|
             if options[:keep_timestamps] || options[:keep_ts]
-              ary.concat itf.packets.map { |pkt| { pkt.timestamp => pkt.data.to_s } }
+              ary.concat(itf.packets.map { |pkt| { pkt.timestamp => pkt.data.to_s } })
             else
-              ary.concat itf.packets.map { |pkt| pkt.data.to_s}
+              ary.concat(itf.packets.map { |pkt| pkt.data.to_s })
             end
           end
         end
@@ -188,29 +183,28 @@ module PacketGen
       #   the packets are appended to the file, rather than overwriting it
       # @return [Array] array of 2 elements: filename and size written
       def to_file(filename, options={})
-        mode = ''
-        if options[:append] and ::File.exists? filename
-          mode = 'ab'
-        else
-          mode = 'wb'
-        end
-        ::File.open(filename, mode) {|f| f.write(self.to_s)}
+        mode = if options[:append] && ::File.exist?(filename)
+                 'ab'
+               else
+                 'wb'
+               end
+        ::File.open(filename, mode) { |f| f.write(self.to_s) }
         [filename, self.to_s.size]
       end
-      alias_method :to_f, :to_file
+      alias to_f to_file
 
       # Shorthand method for writing to a file.
       # @param [#to_s] filename
       # @return [Array] see return value from {#to_file}
       def write(filename='out.pcapng')
-        self.to_file(filename.to_s, :append => false)
+        self.to_file(filename.to_s, append: false)
       end
 
       # Shorthand method for appending to a file.
       # @param [#to_s] filename
       # @return [Array] see return value from {#to_file}
       def append(filename='out.pcapng')
-        self.to_file(filename.to_s, :append => true)
+        self.to_file(filename.to_s, append: true)
       end
 
       # @overload array_to_file(ary)
@@ -235,12 +229,12 @@ module PacketGen
         when Hash
           filename = options[:filename] || options[:file]
           ary = options[:array] || options[:arr]
-          unless ary.kind_of? Array
+          unless ary.is_a? Array
             raise ArgumentError, ':array parameter needs to be an array'
           end
           ts = options[:timestamp] || options[:ts] || Time.now
           ts_inc = options[:ts_inc] || 1
-          append = !!options[:append]
+          append = !options[:append].nil?
         when Array
           ary = options
           ts = Time.now
@@ -253,7 +247,7 @@ module PacketGen
 
         section = SHB.new
         @sections << section
-        itf = IDB.new(:endian => section.endian)
+        itf = IDB.new(endian: section.endian)
         classify_block section, itf
 
         ary.each_with_index do |pkt, i|
@@ -270,24 +264,23 @@ module PacketGen
           this_ts = (this_ts / itf.ts_resol).to_i
           this_tsh = this_ts >> 32
           this_tsl = this_ts & 0xffffffff
-          this_pkt = EPB.new(:endian       => section.endian,
-                             :interface_id => 0,
-                             :tsh          => this_tsh,
-                             :tsl          => this_tsl,
-                             :cap_len      => this_cap_len,
-                             :orig_len     => this_cap_len,
-                             :data         => this_data)
+          this_pkt = EPB.new(endian:       section.endian,
+                             interface_id: 0,
+                             tsh:          this_tsh,
+                             tsl:          this_tsl,
+                             cap_len:      this_cap_len,
+                             orig_len:     this_cap_len,
+                             data:         this_data)
           classify_block section, this_pkt
         end
 
         if filename
-          self.to_f(filename, :append => append)
+          self.to_f(filename, append: append)
         else
           self
         end
       end
 
-
       private
 
       # Parse a section. A section is made of at least a SHB. It than may contain
@@ -304,19 +297,19 @@ module PacketGen
         if shb.section_len.to_i != 0xffffffffffffffff
           # Section length is defined
           section = StringIO.new(io.read(shb.section_len.to_i))
-          while !section.eof? do
+          until section.eof?
             shb = @sections.last
             type = Types::Int32.new(0, shb.endian).read(section.read(4))
             section.seek(-4, IO::SEEK_CUR)
-            block = parse(type, section, shb)
+            parse(type, section, shb)
           end
         else
           # section length is undefined
-          while !io.eof?
+          until io.eof?
             shb = @sections.last
             type = Types::Int32.new(0, shb.endian).read(io.read(4))
             io.seek(-4, IO::SEEK_CUR)
-            block = parse(type, io, shb)
+            parse(type, io, shb)
           end
         end
       end
@@ -327,11 +320,11 @@ module PacketGen
       # @param [SHB] shb header of current section
       # @return [void]
       def parse(type, io, shb)
-        types = PcapNG.constants(false).select { |c| c.to_s =~ /_TYPE/ }.
-          map { |c| [PcapNG.const_get(c).to_i, c] }
+        types = PcapNG.constants(false).select { |c| c.to_s =~ /_TYPE/ }
+                      .map { |c| [PcapNG.const_get(c).to_i, c] }
         types = Hash[types]
 
-        if types.has_key?(type.to_i)
+        if types.key?(type.to_i)
           klass = PcapNG.const_get(types[type.to_i].to_s.gsub(/_TYPE/, '').to_sym)
           block = klass.new(endian: shb.endian)
         else

data/lib/packetgen/pcapng/idb.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module PcapNG
-
     # {IDB} represents a Interface Description Block (IDB) of a pcapng file.
     #
     # == IDB Definition
@@ -20,9 +19,8 @@ module PacketGen
     #   Int32   :block_len2
     # @author Sylvain Daubert
     class IDB < Block
-
       # Minimum IDB size
-      MIN_SIZE     = 5*4
+      MIN_SIZE = 5 * 4
 
       # Option code for if_tsresol option
       OPTION_IF_TSRESOL = 9
@@ -73,11 +71,11 @@ module PacketGen
       # @param [::String,IO] str_or_io
       # @return [self]
       def read(str_or_io)
-        if str_or_io.respond_to? :read
-          io = str_or_io
-        else
-          io = StringIO.new(force_binary(str_or_io.to_s))
-        end
+        io = if str_or_io.respond_to? :read
+               str_or_io
+             else
+               StringIO.new(force_binary(str_or_io.to_s))
+             end
         return self if io.eof?
 
         self[:type].read io.read(4)
@@ -104,23 +102,22 @@ module PacketGen
       # @param [Boolean] force if +true+, force decoding even if already done
       # @return [Float]
       def ts_resol(force: false)
-        if @options_decoded and not force
+        if @options_decoded && !force
           @ts_resol
         else
-          packstr = (@endian == :little) ? 'v' : 'n'
+          packstr = @endian == :little ? 'v' : 'n'
           idx = 0
           options = self[:options]
-          opt_code = opt_len = 0
 
-          while idx < options.length do
+          while idx < options.length
             opt_code, opt_len = options[idx, 4].unpack("#{packstr}2")
-            if opt_code == OPTION_IF_TSRESOL and opt_len == 1
-              tsresol = options[idx+4, 1].unpack('C').first
-              if tsresol & 0x80 == 0
-                @ts_resol = 10 ** -tsresol
-              else
-                @ts_resol = 2 ** -(tsresol & 0x7f)
-              end
+            if opt_code == OPTION_IF_TSRESOL && opt_len == 1
+              tsresol = options[idx + 4, 1].unpack('C').first
+              @ts_resol = if (tsresol & 0x80).zero?
+                            10**-tsresol
+                          else
+                            2**-(tsresol & 0x7f)
+                          end
 
               @options_decoded = true
               return @ts_resol
@@ -130,7 +127,7 @@ module PacketGen
           end
 
           @options_decoded = true
-          @ts_resol = 1E-6  # default value
+          @ts_resol = 1E-6 # default value
         end
       end
 
@@ -141,8 +138,6 @@ module PacketGen
         recalc_block_len
         super << @packets.map(&:to_s).join
       end
-
     end
-
   end
 end

data/lib/packetgen/pcapng/shb.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module PcapNG
-
     # {SHB} represents a Section Header Block (SHB) of a pcapng file.
     #
     # == SHB Definition
@@ -21,7 +20,6 @@ module PacketGen
     #   Int32   :block_len2
     # @author Sylvain Daubert
     class SHB < Block
-
       # @return [:little, :big]
       attr_accessor :endian
       # Get interfaces for this section
@@ -39,7 +37,7 @@ module PacketGen
       MAGIC_BIG    = [MAGIC_INT32].pack('N')
 
       # Minimum SHB size
-      MIN_SIZE     = 7*4
+      MIN_SIZE = 7 * 4
       # +section_len+ value for undefined length
       SECTION_LEN_UNDEFINED = 0xffffffff_ffffffff
 
@@ -91,11 +89,11 @@ module PacketGen
       # @param [::String,IO] str_or_io
       # @return [self]
       def read(str_or_io)
-        if str_or_io.respond_to? :read
-          io = str_or_io
-        else
-          io = StringIO.new(force_binary(str_or_io.to_s))
-        end
+        io = if str_or_io.respond_to? :read
+               str_or_io
+             else
+               StringIO.new(force_binary(str_or_io.to_s))
+             end
         return self if io.eof?
 
         type_str = io.read(4)
@@ -159,12 +157,11 @@ module PacketGen
         super + body
       end
 
-
       private
 
       def force_endianness(endian)
         @endian = endian
-        self[:type]  = Types::Int32.new(self[:type].to_i, endian)
+        self[:type] = Types::Int32.new(self[:type].to_i, endian)
         self[:block_len] = Types::Int32.new(self[:block_len].to_i, endian)
         self[:magic] = Types::Int32.new(self[:magic].to_i, endian)
         self[:ver_major] = Types::Int16.new(self[:ver_major].to_i, endian)