packetgen 2.6.0 → 2.7.0

data/lib/packetgen/types/int.rb

@@ -8,12 +8,10 @@
 
 module PacketGen
   module Types
-
     # Base integer class to handle binary integers
     # @abstract
     # @author Sylvain Daubert
     class Int
-
       # Integer value
       # @return [Integer]
       attr_accessor :value
@@ -135,17 +133,17 @@ module PacketGen
       # @return [self]
       def read(value)
         return self if value.nil?
-        @value =  if value.is_a?(Integer)
-                    value.to_i
-                  else
-                    up8 = down16 = 0
-                    if @endian == :big
-                      up8, down16 = value.to_s.unpack('Cn')
-                    else
-                      down16, up8 = value.to_s.unpack('vC')
-                    end
-                    (up8 << 16) | down16
-                  end
+        @value = if value.is_a?(Integer)
+                   value.to_i
+                 else
+                   up8 = down16 = 0
+                   if @endian == :big
+                     up8, down16 = value.to_s.unpack('Cn')
+                   else
+                     down16, up8 = value.to_s.unpack('vC')
+                   end
+                   (up8 << 16) | down16
+                 end
         self
       end
 

data/lib/packetgen/types/int_string.rb

@@ -8,12 +8,10 @@
 
 module PacketGen
   module Types
-
     # Provides a class for creating strings preceeded by their length as a {Int}.
     # By default, a null string will have one byte length (length byte set to 0).
     # @author Sylvain Daubert
     class IntString
-
       # internal string
       # @return [String]
       attr_reader :string
@@ -40,9 +38,9 @@ module PacketGen
 
       # @param [Integer] l
       # @return [Integer]
-      def length=(l)
-        @length.read l
-        l
+      def length=(len)
+        @length.read len
+        len
       end
 
       # @return [Integer]
@@ -52,9 +50,9 @@ module PacketGen
 
       # @param [#to_s] s
       # @return [String]
-      def string=(s)
-        @length.value = s.to_s.size
-        @string = s.to_s
+      def string=(str)
+        @length.value = str.to_s.size
+        @string = str.to_s
       end
 
       # Get binary string

data/lib/packetgen/types/oui.rb

@@ -8,12 +8,11 @@
 
 module PacketGen
   module Types
-
     # OUI type, defined as a set of 3 bytes
     #  oui = OUI.new
     #  oui.from_human('00:01:02')
     #  oui.to_human   # => "00:01:02"
-    #@author Sylvain Daubert
+    # @author Sylvain Daubert
     class OUI < Types::Fields
       # @attribute b2
       #  @return [Integer] left-most byte
@@ -31,9 +30,7 @@ module PacketGen
       def from_human(str)
         return self if str.nil?
         bytes = str.split(/:/)
-        unless bytes.size == 3
-          raise ArgumentError, 'not a OUI'
-        end
+        raise ArgumentError, 'not a OUI' unless bytes.size == 3
         self[:b2].read(bytes[0].to_i(16))
         self[:b1].read(bytes[1].to_i(16))
         self[:b0].read(bytes[2].to_i(16))
@@ -43,7 +40,7 @@ module PacketGen
       # Get OUI in human readable form (colon-separated bytes)
       # @return [String]
       def to_human
-        fields.map { |m| "#{'%02x' % self[m]}" }.join(':')
+        fields.map { |m| '%02x' % self[m] }.join(':')
       end
     end
   end

data/lib/packetgen/types/string.rb

@@ -8,12 +8,10 @@
 
 module PacketGen
   module Types
-
     # This class is just like regular String. It only adds {#read} and {#sz} methods
     # to be compatible with others {Types}.
     # @author Sylvain Daubert
     class String < ::String
-
       # @param [Hash] options
       # @option options [Types::Int,Proc] :length_from object or proc from which
       #   takes length when reading
@@ -30,14 +28,14 @@ module PacketGen
         s = str.to_s
         str_end = case @length_from
                   when Types::Int
-                    str_end = @length_from.to_i
+                    @length_from.to_i
                   when Proc
-                    str_end = @length_from.call
+                    @length_from.call
                   else
                     if @static_length.is_a? Integer
-                      str_end = @static_length
+                      @static_length
                     else
-                      str_end = s.size
+                      s.size
                     end
                   end
         str_end = 0 if str_end < 0

data/lib/packetgen/types/tlv.rb

@@ -8,7 +8,6 @@
 
 module PacketGen
   module Types
-
     # Class to handle Type-Length-Value attributes
     #
     # TLV fields handles three subfields:
@@ -64,7 +63,7 @@ module PacketGen
       # @param [String] str
       # @return [Fields] self
       def read(str)
-        idx = 0 
+        idx = 0
         self[:type].read str[idx, self[:type].sz]
         idx += self[:type].sz
         self[:length].read str[idx, self[:length].sz]
@@ -86,11 +85,9 @@ module PacketGen
         when Integer
           self.old_type = val
         else
-          unless has_human_types?
-            raise TypeError, 'need an Integer'
-          end
+          raise TypeError, 'need an Integer' unless human_types?
           new_val = self.class::TYPES.key(val.to_s)
-          raise ArgumentError, "unknown #{val.to_s} type" if new_val.nil?
+          raise ArgumentError, "unknown #{val} type" if new_val.nil?
           self.old_type = new_val
         end
       end
@@ -125,7 +122,7 @@ module PacketGen
       # Return human readable type, if TYPES is defined
       # @return [String]
       def human_type
-        if has_human_types?
+        if human_types?
           htype = self.class::TYPES[type]
           htype = type if htype.nil?
           htype.to_s
@@ -137,20 +134,20 @@ module PacketGen
       # @return [String]
       def to_human
         name = self.class.to_s.gsub(/.*::/, '')
-        @typestr ||= if has_human_types?
+        @typestr ||= if human_types?
                        types = self.class::TYPES.values
-                       "%-#{types.max { |a,b| a.length <=> b.length }.size}s"
+                       "%-#{types.max_by(&:length).size}s"
                      else
-                       "%s"
+                       '%s'
                      end
-        @lenstr ||= "%-#{(2**(self[:length].width*8) - 1).to_s.size}u"
-        "#{name} type:#@typestr length:#@lenstr value:#{value.inspect}" % [human_type,
-                                                                           length]
+        @lenstr ||= "%-#{(2**(self[:length].width * 8) - 1).to_s.size}u"
+        "#{name} type:#{@typestr} length:#{@lenstr} value:#{value.inspect}" % [human_type,
+                                                                               length]
       end
 
       private
 
-      def has_human_types?
+      def human_types?
         self.class.const_defined? :TYPES
       end
     end

data/lib/packetgen/utils.rb

@@ -4,11 +4,11 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require_relative 'config'
 require_relative 'utils/arp_spoofer'
 
 module PacketGen
-
   # Collection of some network utilities.
   #
   # This module is not enabled by default. You need to:
@@ -16,29 +16,26 @@ module PacketGen
   # @author Sylvain Daubert
   # @since 2.1.3
   module Utils
-
     # Get local ARP cache
     # @return [Hash] key: IP address, value: array containing MAC address and
     #    interface name
     def self.arp_cache
-      raw_cache = %x(/usr/sbin/arp -an)
+      raw_cache = `/usr/sbin/arp -an`
 
       cache = {}
       raw_cache.split(/\n/).each do |line|
         match = line.match(/\((\d+\.\d+\.\d+\.\d+)\) at (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})(?: \[ether\])? on (\w+)/)
-        if match
-          cache[match[1]] = [match[2], match[4]]
-        end
+        cache[match[1]] = [match[2], match[4]] if match
       end
-      
+
       cache
     end
-    
+
     # Get MAC address from an IP address, or nil if this IP address is unknown
     # on local network.
     # @param [String] ipaddr dotted-octet IP address
     # @param [Hash] options
-    # @option options [String] :iface interface name. Default to 
+    # @option options [String] :iface interface name. Default to
     #   {PacketGen.default_iface}
     # @option options [Boolean] :no_cache if +true+, do not query local ARP
     #   cache and always send an ARP request on wire. Default to +false+
@@ -48,7 +45,7 @@ module PacketGen
     def self.arp(ipaddr, options={})
       unless options[:no_cache]
         local_cache = self.arp_cache
-        return local_cache[ipaddr].first if local_cache.has_key? ipaddr
+        return local_cache[ipaddr].first if local_cache.key? ipaddr
       end
 
       iface = options[:iface] || PacketGen.default_iface
@@ -56,8 +53,8 @@ module PacketGen
       my_hwaddr = Config.instance.hwaddr(iface)
       arp_pkt = Packet.gen('Eth', dst: 'ff:ff:ff:ff:ff:ff', src: my_hwaddr)
       arp_pkt.add('ARP', sha: Config.instance.hwaddr, spa: Config.instance.ipaddr,
-                  tpa: ipaddr)
-      
+                         tpa: ipaddr)
+
       capture = Capture.new(iface: iface, timeout: timeout, max: 1,
                             filter: "arp src #{ipaddr} and ether dst #{my_hwaddr}")
       cap_thread = Thread.new do
@@ -66,18 +63,13 @@ module PacketGen
 
       arp_pkt.to_w(iface)
       cap_thread.join
-      
-      if capture.packets.size > 0
-        capture.packets.each do |pkt|
-          if pkt.arp.spa.to_s == ipaddr
-            break pkt.arp.sha.to_s
-          end
-        end
-      else
-        nil
+
+      return if capture.packets.empty?
+      capture.packets.each do |pkt|
+        break pkt.arp.sha.to_s if pkt.arp.spa.to_s == ipaddr
       end
     end
-    
+
     # Do ARP spoofing on given IP address. Call to this method blocks.
     # @note This method is provided for test purpose.
     # For more control, see {ARPSpoofer} class.
@@ -133,7 +125,7 @@ module PacketGen
       spoofer = Utils::ARPSpoofer.new(options)
       spoofer.add target1, target2, options
       spoofer.add target2, target1, options
-      
+
       my_mac = Config.instance.hwaddr(options[:iface])
       my_ip = Config.instance.ipaddr(options[:iface])
       capture = Capture.new(iface: options[:iface],

data/lib/packetgen/utils/arp_spoofer.rb

@@ -4,11 +4,11 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'thread'
 
 module PacketGen
   module Utils
-
     # @note This class is provided for test purpose.
     # Utility class to make ARP spoofing.
     #   spoofer = PacketGen::Utils::ARPSpoofer.new
@@ -23,7 +23,6 @@ module PacketGen
     # @author Sylvain Daubert
     # @since 2.1.3
     class ARPSpoofer
-
       # @param [Integer,Float,nil] timeout spoof will happen for this amount
       #  of time
       # @param [Integer,Float] interval time between 2 ARP packets
@@ -51,7 +50,7 @@ module PacketGen
       #  an ARP request is made to get it.
       # @return [void]
       def add(target_ip, spoofed_ip, options={})
-        @targets[target_ip] = options.merge({spoofed_ip: spoofed_ip, active: false})
+        @targets[target_ip] = options.merge(spoofed_ip: spoofed_ip, active: false)
       end
 
       # Remove target from spoofer.
@@ -104,7 +103,7 @@ module PacketGen
           activate target_ip
         end
       end
-      
+
       # Stop spoofing on all targets.
       # @return [void]
       def stop_all
@@ -117,11 +116,8 @@ module PacketGen
       # @param [String] target_ip target IP address
       # @return [Boolean,nil]
       def active?(target_ip)
-        if @targets.has_key?(target_ip)
-          @targets[target_ip][:active]
-        else
-          nil
-        end
+        return unless @targets.key?(target_ip)
+        @targets[target_ip][:active]
       end
 
       # Wait for spoofing to finish. Wait forever if no +timeout+ options
@@ -138,16 +134,14 @@ module PacketGen
       def activate(target_ip)
         @arp_packets[target_ip] = make_arp_packet(target_ip)
         @queue << @arp_packets.values
-        unless @spoof_thread
-          create_spoof_thread
-        end
+        create_spoof_thread unless @spoof_thread
         @targets[target_ip][:active] = true
       end
-      
+
       # Create spoof thread
       def create_spoof_thread
-        @spoof_thread = Thread.new(@queue, @iface, @timeout, @interval) do |queue, iface, timeout, interval|
-          while timeout.nil? or timeout > 0.0 do
+        @spoof_thread = Thread.new(@queue, @timeout, @interval) do |queue, timeout, interval|
+          while timeout.nil? || timeout > 0.0
             packets = queue.pop unless queue.empty?
             send_packets_on_wire(packets) unless packets.empty?
             timeout -= interval if timeout
@@ -184,9 +178,9 @@ module PacketGen
 
         target_mac = params[:target_mac] || Utils.arp(target_ip)
 
-        Packet.gen('Eth', dst: target_mac, src: mac).
-               add('ARP', op: 'reply', sha: mac, spa: params[:spoofed_ip],
-                   tha: target_mac, tpa: target_ip)
+        Packet.gen('Eth', dst: target_mac, src: mac)
+              .add('ARP', op: 'reply', sha: mac, spa: params[:spoofed_ip],
+                          tha: target_mac, tpa: target_ip)
       end
     end
   end

data/lib/packetgen/version.rb

@@ -10,5 +10,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '2.6.0'
+  VERSION = '2.7.0'
 end

data/packetgen.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'packetgen/version'
 
@@ -10,8 +11,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Sylvain Daubert']
   spec.email         = ['sylvain.daubert@laposte.net']
 
-  spec.summary       = %q{Network packet generator and analyzor}
-  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.summary       = 'Network packet generator and dissector'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = 'https://github.com/sdaubert/packetgen'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -23,13 +24,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_dependency 'pcaprub', '~>0.12.4'
   spec.add_dependency 'interfacez', '~>1.0'
+  spec.add_dependency 'pcaprub', '~>0.12.4'
   spec.add_dependency 'rasn1', '~>0.5', '>= 0.6.3'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pcaprub
+  name: interfacez
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.4
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.4
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: interfacez
+  name: pcaprub
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.12.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.12.4
 - !ruby/object:Gem::Dependency
   name: rasn1
   requirement: !ruby/object:Gem::Requirement
@@ -64,56 +64,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -146,6 +147,7 @@ files:
 - lib/packetgen.rb
 - lib/packetgen/capture.rb
 - lib/packetgen/config.rb
+- lib/packetgen/deprecation.rb
 - lib/packetgen/header.rb
 - lib/packetgen/header/arp.rb
 - lib/packetgen/header/asn1_base.rb
@@ -296,5 +298,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Network packet generator and analyzor
+summary: Network packet generator and dissector
 test_files: []