packetgen 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df09d9bda17671562435fd055b6ab552aa3e19798251f953e1e260786bae168d
-  data.tar.gz: 79baa63b2cfa57534246b3806033dc6233ea9a2ae9da3c6aa0dc9dc803983d97
+  metadata.gz: 0c68cb5128a07a395378b28ecf7ab5711be938cbc5fb2807d42b7cb9a946ed5d
+  data.tar.gz: cb5d764d681dcda886a0fd2b5c3d852aa1eb477edb116286e8ac449e7170c5bd
 SHA512:
-  metadata.gz: a6f3349f7d168b5b8391fa78e1ed90763295c7dc8db21bc0ee517195f96ca290172ad788c2c3fe4d2787809209fc502be4b05f00df6bc9f595709edf06136618
-  data.tar.gz: d218ba23d8c02253d75bd18f1ea552ce3aee8490895c0886504f443d87f18bbd0ed7c3e0ca13bc30f7bcf4db5fbb7abe7e4c0630bfc1f5fd36b750faa130e56c
+  metadata.gz: de785e82d0bc1d5d1a00d6069a74e120fdd6323bd68ab1c06e285967e2d6ab6c32caec8a8079e393cd52076d81d7ab0ccbbb2522d4212264181a7c5033a8718a
+  data.tar.gz: fa91feb360719d3a10a7b984cc89c1cb1c842ec69b41121029f68b374e0a2db03f02ea50898b78fb1ce439dd0aed3a2e60635acb8242e71a01184faaece91c99

data/.gitignore

@@ -8,5 +8,6 @@
 /spec/reports/
 /tmp/
 /vendor/
+/.vscode/
 *~
 tags

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+Lint/EmptyWhen:
+  Enabled: false
+Lint/Void:
+  Enabled: false
+Metrics:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+Style/EvalWithLocation:
+  Enabled: false
+Style/FormatString:
+  EnforcedStyle: percent
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+Style/PerlBackrefs:
+  Enabled: false
+Style/RedundantSelf:
+  Enabled: false
+Style/StructInheritance:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/Rakefile

@@ -2,17 +2,17 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yard'
 
-task :default => :spec
+task default: :spec
 
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = '-t ~sudo'
 end
 RSpec::Core::RakeTask.new('spec:sudo') do |t|
-  if ENV['TRAVIS']
-    t.rspec_opts = '-t sudo -t ~notravis'
-  else
-    t.rspec_opts = '-t sudo'
-  end
+  t.rspec_opts = if ENV['TRAVIS']
+                   '-t sudo -t ~notravis'
+                 else
+                   '-t sudo'
+                 end
 end
 
 YARD::Rake::YardocTask.new do |t|

data/bin/pgconsole

@@ -8,7 +8,7 @@ use_pry = false
 begin
   require 'pry'
   use_pry = true
-  puts "use Pry!"
+  puts 'use Pry!'
 rescue LoadError
   require 'irb'
   require 'irb/completion'
@@ -29,7 +29,7 @@ class PgConsole
   Utils.singleton_methods.each do |m|
     define_method m, Utils.method(m).to_proc
   end
-  
+
   def get_binding
     binding
   end
@@ -57,11 +57,11 @@ else
   irb = IRB::Irb.new(IRB::WorkSpace.new(PgConsole.new.get_binding))
   IRB.conf[:MAIN_CONTEXT] = irb.context
   irb.context.auto_indent_mode = true
-  irb.context.prompt_i = "pg> "
-  irb.context.prompt_s = "pg* "
-  irb.context.prompt_c = "pg* "
+  irb.context.prompt_i = 'pg> '
+  irb.context.prompt_s = 'pg* '
+  irb.context.prompt_c = 'pg* '
 
-  trap("SIGINT") do
+  trap('SIGINT') do
     irb.signal_handle
   end
 

data/lib/packetgen.rb

@@ -5,12 +5,12 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'packetgen/version'
 
 # PacketGen is a network packet generator and analyzor.
 # @author Sylvain Daubert
 module PacketGen
-
   # Base exception class for PacketGen exceptions
   class Error < StandardError; end
 
@@ -75,15 +75,16 @@ module PacketGen
     return @default_iface if @default_iface
 
     ipaddr = `ip addr`.split("\n")
-    @default_iface = ipaddr.each_with_index do |line, i|
+    @default_iface = ipaddr.each do |line|
       m = line.match(/^\d+: (\w+\d+):/)
       next if m.nil?
-      next if m[1] == 'lo'
+      next if m[1].start_with? 'lo'
       break m[1]
     end
   end
 end
 
+require 'packetgen/deprecation'
 require 'packetgen/types'
 require 'packetgen/inspect'
 require 'packetgen/pcapng'

data/lib/packetgen/capture.rb

@@ -8,12 +8,10 @@
 require 'interfacez'
 
 module PacketGen
-
   # Capture packets from wire
   # @author Sylvain Daubert
   # @author Kent 'picat' Gruber
   class Capture
-
     # Default snaplen to use if :snaplen option not defined.
     DEFAULT_SNAPLEN = 0xffff
 
@@ -69,10 +67,10 @@ module PacketGen
             packet = Packet.parse(packet_data)
             @packets << packet
             yield packet if block_given?
-          else
-            yield packet_data if block_given?
+          elsif block_given?
+            yield packet_data
           end
-          break if @max and @raw_packets.size >= @max
+          break if @max && @raw_packets.size >= @max
         end
       end
       @cap_thread.join(@timeout)
@@ -93,9 +91,9 @@ module PacketGen
       @max = options[:max] if options[:max]
       @filter = options[:filter] if options[:filter]
       @timeout = options[:timeout] if options[:timeout]
-      @promisc = options[:promisc] if options.has_key? :promisc
+      @promisc = options[:promisc] if options.key? :promisc
       @snaplen = options[:snaplen] if options[:snaplen]
-      @parse = options[:parse] if options.has_key? :parse
+      @parse = options[:parse] if options.key? :parse
       @iface = options[:iface] if options[:iface]
     end
 

data/lib/packetgen/config.rb

@@ -4,12 +4,12 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'socket'
 require 'singleton'
 require 'interfacez'
 
 module PacketGen
-
   # Config class to provide +config+ object to pgconsole
   # @author Sylvain Daubert
   # @author Kent 'picat' Gruber
@@ -41,14 +41,14 @@ module PacketGen
     def hwaddr(iface=nil)
       @hwaddr[iface || @default_iface]
     end
-    
+
     # Get IP address for given network interface
     # @param [String,nil] iface network interface. If +nil+, use default one.
     # @return [String]
     def ipaddr(iface=nil)
       @ipaddr[iface || @default_iface]
     end
-        
+
     # Get IPv6 addresses for given network interface
     # @param [String,nil] iface network interface. If +nil+, use default one.
     # @return [Array<String>]

data/lib/packetgen/deprecation.rb

@@ -0,0 +1,17 @@
+module PacketGen
+  # Deprecation module
+  # @since 2.7.0
+  # @author Sylvain Daubert
+  # @api private
+  module Deprecation
+    def self.deprecated(klass, deprecated_method, new_method, klass_method: false, remove_version: '3.0.0')
+      separator = klass_method ? '.' : '#'
+      base_name = klass.to_s + separator
+      complete_deprecated_method_name = base_name + deprecated_method.to_s
+      complete_new_method_name = base_name + new_method.to_s
+
+      warn "#{complete_deprecated_method_name} is deprecated in favor of #{complete_new_method_name}. " \
+           "It will be remove in PacketGen #{remove_version}."
+    end
+  end
+end

data/lib/packetgen/header.rb

@@ -13,8 +13,8 @@ module PacketGen
   # First, define the new header class. By example:
   #  module MyModule
   #    class MyHeader < PacketGen::Header::Base
-  #      define_field :field1, PacketGen::Types::Int32   
-  #      define_field :field2, PacketGen::Types::Int32   
+  #      define_field :field1, PacketGen::Types::Int32
+  #      define_field :field2, PacketGen::Types::Int32
   #    end
   #   end
   # Then, class must be declared to PacketGen:
@@ -27,7 +27,6 @@ module PacketGen
   #  pkt.myheader.field2.read 0x01
   # @author Sylvain Daubert
   module Header
-
     # @private snap length for PCAPRUB
     PCAP_SNAPLEN = 0xffff
     # @private promiscuous (or not) for PCAPRUB
@@ -37,44 +36,47 @@ module PacketGen
 
     @added_header_classes = {}
 
-    # Get known header classes
-    # @return [Array<Class>]
-    def self.all
-      return @header_classes if @header_classes
-      @header_classes = @added_header_classes.values
-    end
+    class << self
+      # List all available headers.
+      # @return [Array<Class>]
+      def all
+        return @header_classes if @header_classes
+        @header_classes = @added_header_classes.values
+      end
+      alias list all
 
-    # Add a foreign header class to known header classes. This is
-    # needed by {Packet.gen} and {Packet#add}.
-    # @param [Class] klass a header class
-    # @return [void]
-    # @since 1.1.0
-    def self.add_class(klass)
-      protocol_name = klass.new.protocol_name
-      @added_header_classes[protocol_name] = klass
-      @header_classes = nil
-    end
+      # Add a foreign header class to known header classes. This is
+      # needed by {Packet.gen} and {Packet#add}.
+      # @param [Class] klass a header class
+      # @return [void]
+      # @since 1.1.0
+      def add_class(klass)
+        protocol_name = klass.new.protocol_name
+        @added_header_classes[protocol_name] = klass
+        @header_classes = nil
+      end
 
-    # Remove a foreign header (previously added by {.add_header_class}
-    # from known header classes.
-    # @param [Class] klass
-    # @return [void]
-    # @since 1.1.0
-    def self.remove_class(klass)
-      protocol_name = klass.new.protocol_name
-      @added_header_classes.delete protocol_name
-      @header_classes = nil
-    end
+      # Remove a foreign header (previously added by {.add_header_class}
+      # from known header classes.
+      # @param [Class] klass
+      # @return [void]
+      # @since 1.1.0
+      def remove_class(klass)
+        protocol_name = klass.new.protocol_name
+        @added_header_classes.delete protocol_name
+        @header_classes = nil
+      end
 
-    # Get header class from its name
-    # @param [String] name
-    # @return [Class,nil]
-    # @since 1.1.0
-    def self.get_header_class_by_name(name)
-      if Header.const_defined? name
-        Header.const_get name
-      else
-        @added_header_classes[name]
+      # Get header class from its name
+      # @param [String] name
+      # @return [Class,nil]
+      # @since 1.1.0
+      def get_header_class_by_name(name)
+        if Header.const_defined? name
+          Header.const_get name
+        else
+          @added_header_classes[name]
+        end
       end
     end
   end

data/lib/packetgen/header/arp.rb

@@ -7,7 +7,6 @@
 
 module PacketGen
   module Header
-
     # An ARP header consists of:
     # * a hardware type ({#hrd} or {#htype}) field ({Types::Int16}),
     # * a protocol type ({#pro} or {#ptype}) field (+Int16+),
@@ -30,7 +29,6 @@ module PacketGen
     #
     # @author Sylvain Daubert
     class ARP < Base
-
       # @!attribute hrd
       #  16-bit hardware protocol type
       #  # @return [Integer]
@@ -83,41 +81,58 @@ module PacketGen
       # @option options [String] :tha target hardware address
       # @option options [String] :tpa targetr internet address
       def initialize(options={})
-        options[:hrd] ||= options[:htype] 
-        options[:pro] ||= options[:ptype] 
-        options[:hln] ||= options[:hlen] 
-        options[:pln] ||= options[:plen] 
-        options[:op]  ||= options[:opcode] 
-        options[:sha] ||= options[:src_mac] 
-        options[:spa] ||= options[:src_ip] 
-        options[:tha] ||= options[:dst_mac] 
+        options[:hrd] ||= options[:htype]
+        options[:pro] ||= options[:ptype]
+        options[:hln] ||= options[:hlen]
+        options[:pln] ||= options[:plen]
+        options[:op]  ||= options[:opcode]
+        options[:sha] ||= options[:src_mac]
+        options[:spa] ||= options[:src_ip]
+        options[:tha] ||= options[:dst_mac]
         options[:tpa] ||= options[:dst_ip]
-        super 
+        super
       end
 
-      alias :htype :hrd
-      alias :htype= :hrd=
-      alias :ptype :pro
-      alias :ptype= :pro=
-      alias :hlen :hln
-      alias :hlen= :hln=
-      alias :plen :pln
-      alias :plen= :pln=
-      alias :opcode :op
-      alias :opcode= :op=
-      alias :src_mac :sha
-      alias :src_mac= :sha=
-      alias :src_ip :spa
-      alias :src_ip= :spa=
-      alias :dst_mac :tha
-      alias :dst_mac= :tha=
-      alias :dst_ip :tpa
-      alias :dst_ip= :tpa=
+      alias htype hrd
+      alias htype= hrd=
+      alias ptype pro
+      alias ptype= pro=
+      alias hlen hln
+      alias hlen= hln=
+      alias plen pln
+      alias plen= pln=
+      alias opcode op
+      alias opcode= op=
+      alias src_mac sha
+      alias src_mac= sha=
+      alias src_ip spa
+      alias src_ip= spa=
+      alias dst_mac tha
+      alias dst_mac= tha=
+      alias dst_ip tpa
+      alias dst_ip= tpa=
+
+      # Invert data to create a reply.
+      # @return [self]
+      def reply!
+        case opcode.to_i
+        when 1
+          self.opcode = 2
+          self.spa, self.tpa = self.tpa, self.spa
+          self.sha, self.tha = self.tha, self.sha
+        when 2
+          self.opcode = 1
+          self.spa, self.tpa = self.tpa, self.spa
+          self.sha = self.tha
+          self[:tha].from_human('00:00:00:00:00:00')
+        end
+        self
+      end
     end
 
     self.add_class ARP
 
-    Eth.bind_header ARP, ethertype: 0x806
-    Dot1q.bind_header ARP, ethertype: 0x806
+    Eth.bind ARP, ethertype: 0x806
+    Dot1q.bind ARP, ethertype: 0x806
   end
 end

data/lib/packetgen/header/asn1_base.rb

@@ -4,22 +4,22 @@
 # This program is published under MIT license.
 
 # frozen_string_literal: true
+
 require 'rasn1'
 
 module PacketGen
   module Header
-
     # @abstract Base class for ASN.1 header types.
     #    This class implement minimal {Base} API to mimic a {Base} object.
     #
     #    Subclasses may define magic methods:
     #    * {#parse?}.
     # @author Sylvain Daubert
+    # @since 2.0.0
     class ASN1Base < RASN1::Model
-
       # Reference on packet which owns this header
       # @return [Packet,nil]
-      attr_accessor :packet
+      attr_reader :packet
 
       # Give protocol name for this class
       # @return [String]
@@ -51,6 +51,7 @@ module PacketGen
                            classname.sub(/.*::/, '')
                          end
       end
+
       # return header method name
       # @return [String]
       # @since 2.0.0
@@ -77,17 +78,16 @@ module PacketGen
         added_to_packet(packet)
         @packet
       end
-      
+
       # @abstract This method is called when a header is added to a packet.
       #   This base method does nothing but may be overriden by subclasses.
       # @param [Packet] packet packet to which self is added
       # @return [void]
       # @since 2.1.4
-      def added_to_packet(packet)
-      end
+      def added_to_packet(packet) end
 
-      alias :parse :parse!
-      alias :to_s :to_der
+      alias parse parse!
+      alias to_s to_der
 
       # Read a BER string
       # @param [String] str