packetgen 3.1.4 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2adf2b07c2d2d334e4f0ae6e4e7b49571d4d436788bef51df6cf7c1a5aaba9c8
-  data.tar.gz: 8997321a31379ea6952ab42a4642d98a717587ed777652ebdb9e25b5928cc8d4
+  metadata.gz: 8f3faa715cd36e918df79355267c50690bdde15f1566e23947d26890e7b89a82
+  data.tar.gz: d374447f230500b0c5be84b225d3a5576f019afc4870dc6512c659bc2e069d67
 SHA512:
-  metadata.gz: b5af6e0d04f8bb03af01d63cde3879a6a13c8a78477811be2b95fee5c597820f4714f8ac8b69f4aa8f04d3d5b81c5e25b5787815ee2237a8c3329721b5dc7895
-  data.tar.gz: 6eebb203f8dfde49505987d16778c1ecbc81c463d6ac8b5f005e2c6f486166ba0cceabd848d3b3aeebe867b138993171026e8dcacfb04c84a126bc149ff5c616
+  metadata.gz: de7911facea630eaa2d3d4afd2ae15e1cbd927241ebf0c63ec096c64eac31c58e519d379476763c50fc1b4290029cec4b14dbf9e96ae9aa05dc06701cf45af32
+  data.tar.gz: 69881fc66b4af80177bdad4b5b2daa4bd28259596bbf8a36112998aa9a8c117c7c9898180372635fcc1b47376e2fab4fb5cece88be5c000277cdce825fb03168

data/README.md

@@ -1,6 +1,5 @@
 
 [![Gem Version](https://badge.fury.io/rb/packetgen.svg)](https://badge.fury.io/rb/packetgen)
-[![Build Status](https://travis-ci.org/sdaubert/packetgen.svg?branch=master)](https://travis-ci.org/sdaubert/packetgen)
 
 # PacketGen
 

data/bin/pgconsole

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'packetgen'
 require 'packetgen/config'

data/lib/packetgen.rb

@@ -32,6 +32,7 @@ module PacketGen
     attr_reader :hdr
 
     def initialize(prev_hdr, hdr)
+      super()
       @prev_hdr = prev_hdr
       @hdr = hdr
     end
@@ -66,7 +67,7 @@ module PacketGen
   # @yieldparam [Packet] packet
   # @return [Array<Packet>]
   def self.capture(**kwargs)
-    Packet.capture(kwargs) { |packet| yield packet if block_given? }
+    Packet.capture(**kwargs) { |packet| yield packet if block_given? }
   end
 
   # Shortcut for {Packet.read}
@@ -94,7 +95,21 @@ module PacketGen
   # Get default network interface (ie. first non-loopback declared interface)
   # @return [String]
   def self.default_iface
-    Interfacez.default
+    return @default_iface if defined? @default_iface
+
+    @default_iface = Interfacez.raw_interface_addresses.each do |iface|
+      next unless iface.broadaddr
+      next unless Interfacez.ipv4_address_of(iface.name)
+      next unless Interfacez.ipv6_address_of(iface.name)
+
+      break iface.name
+    end
+  end
+
+  # Get loopback network interface
+  # @return [String]
+  def self.loopback_iface
+    Interfacez.loopback
   end
 
   # Shortcut to get a header class
@@ -114,11 +129,12 @@ module PacketGen
 end
 
 require 'packetgen/deprecation'
-require 'packetgen/types'
 require 'packetgen/inspect'
+require 'packetgen/types'
 require 'packetgen/pcapng'
 require 'packetgen/pcap'
 require 'packetgen/packet'
+require 'packetgen/unknown_packet'
 require 'packetgen/capture'
 require 'packetgen/inject'
 require 'packetgen/proto'

data/lib/packetgen/capture.rb

@@ -13,7 +13,9 @@ module PacketGen
   class Capture
     private
 
-    attr_reader :filter, :cap_thread, :snaplen, :promisc
+    attr_reader :filter, :cap_thread, :snaplen, :promisc, :monitor
+
+    # rubocop:disable Metrics/ParameterLists
 
     public
 
@@ -41,14 +43,18 @@ module PacketGen
     #    yielding.  Default: +true+
     # @param [Integer] snaplen maximum number of bytes to capture for
     #    each packet.
+    # @param [Boolean] monitor enable or disable monitor mode on interface (if supported by +iface+).
     # @since 2.0.0 remove old 1.x API
     # @since 3.0.0 arguments are kwargs and no more a hash
-    def initialize(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: nil)
-      @iface = iface || Interfacez.default || Interfacez.loopback
+    # @since 3.1.5 add monitor argument
+    # @author Sylvain Daubert
+    # @author optix2000 - add monitor argument
+    def initialize(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: nil, monitor: nil)
+      @iface = iface || PacketGen.default_iface || PacketGen.loopback_iface
 
       @packets     = []
       @raw_packets = []
-      set_options iface, max, timeout, filter, promisc, parse, snaplen
+      set_options iface, max, timeout, filter, promisc, parse, snaplen, monitor
     end
 
     # Start capture
@@ -56,8 +62,11 @@ module PacketGen
     # @yieldparam [Packet,String] packet if a block is given, yield each
     #    captured packet (Packet or raw data String, depending on +:parse+ option)
     # @since 3.0.0 arguments are kwargs and no more a hash
-    def start(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: nil, &block)
-      set_options iface, max, timeout, filter, promisc, parse, snaplen
+    # @since 3.1.5 add monitor argument
+    # @author Sylvain Daubert
+    # @author optix2000 - add monitor argument
+    def start(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: nil, monitor: nil, &block)
+      set_options iface, max, timeout, filter, promisc, parse, snaplen, monitor
 
       @cap_thread = Thread.new do
         PCAPRUBWrapper.capture(**capture_args) do |packet_data|
@@ -79,7 +88,10 @@ module PacketGen
 
     private
 
-    def set_options(iface, max, timeout, filter, promisc, parse, snaplen)
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+
+    def set_options(iface, max, timeout, filter, promisc, parse, snaplen, monitor)
       @max = max if max
       @filter = filter unless filter.nil?
       @timeout = timeout unless timeout.nil?
@@ -87,10 +99,15 @@ module PacketGen
       @snaplen = snaplen unless snaplen.nil?
       @parse = parse unless parse.nil?
       @iface = iface unless iface.nil?
+      @monitor = monitor unless monitor.nil?
     end
 
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/ParameterLists
+
     def capture_args
-      h = { iface: iface, filter: filter }
+      h = { iface: iface, filter: filter, monitor: monitor }
       h[:snaplen] = snaplen unless snaplen.nil?
       h[:promisc] = promisc unless promisc.nil?
       h
@@ -105,7 +122,11 @@ module PacketGen
     def add_packet(data, &block)
       raw_packets << data
       if @parse
-        packet = Packet.parse(data)
+        begin
+          packet = Packet.parse(data)
+        rescue ParseError
+          packet = UnknownPacket.new.parse(data)
+        end
         packets << packet
         block&.call(packet)
       elsif block

data/lib/packetgen/config.rb

@@ -22,37 +22,43 @@ module PacketGen
     attr_reader :default_iface
 
     def initialize
-      @default_iface = Interfacez.default || Interfacez.loopback
+      @default_iface = PacketGen.default_iface || PacketGen.loopback_iface
       @hwaddr = {}
       @ipaddr = {}
       @ip6addr = {}
 
-      Interfacez.all do |iface_name|
-        @hwaddr[iface_name] = Interfacez.mac_address_of(iface_name)
-        @ipaddr[iface_name] = Interfacez.ipv4_address_of(iface_name)
-        @ip6addr[iface_name] = Interfacez.ipv6_addresses_of(iface_name)
-      end
+      initialize_local_addresses
     end
 
     # Get MAC address for given network interface
     # @param [String,nil] iface network interface. If +nil+, use default one.
     # @return [String]
     def hwaddr(iface=nil)
-      @hwaddr[iface || @default_iface]
+      @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]
+      @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>]
     def ip6addr(iface=nil)
-      @ip6addr[iface || @default_iface]
+      @ip6addr[iface || default_iface]
+    end
+
+    private
+
+    def initialize_local_addresses
+      Interfacez.all do |iface_name|
+        @hwaddr[iface_name] = Interfacez.mac_address_of(iface_name)
+        @ipaddr[iface_name] = Interfacez.ipv4_address_of(iface_name)
+        @ip6addr[iface_name] = Interfacez.ipv6_addresses_of(iface_name)
+      end
     end
   end
 end

data/lib/packetgen/deprecation.rb

@@ -31,7 +31,7 @@ module PacketGen
       complete_deprecated_method_name = "#{base_name}#{deprecated_method}"
       complete_new_method_name = "#{base_name}#{new_method}" unless new_method.nil?
 
-      file, line = caller(2..2).split(':')[0, 2]
+      file, line = caller(2..2).first.split(':')[0, 2]
       message = +"#{file}:#{line}: #{complete_deprecated_method_name} is deprecated"
       message << " in favor of #{complete_new_method_name}" unless new_method.nil?
       message << '. ' << self.removed(remove_version)

data/lib/packetgen/header/asn1_base.rb

@@ -19,14 +19,20 @@ module PacketGen
     class ASN1Base < RASN1::Model
       include Headerable
 
-      # Define some methods from given ASN.1 fields to mimic {Base} attributes
-      # @param [Array<Symbol>] attributes
-      # @return [void]
-      def self.define_attributes(*attributes)
-        @attributes = attributes
-        attributes.each do |attr|
-          class_eval "def #{attr}; @elements[:#{attr}].value; end\n" \
-                     "def #{attr}=(v); @elements[:#{attr}].value = v; end"
+      class <<self
+        # Define some methods from given ASN.1 fields to mimic {Base} attributes
+        # @param [Array<Symbol>] attributes
+        # @return [void]
+        def define_attributes(*attributes)
+          @attributes = attributes
+          attributes.each do |attr|
+            class_eval "def #{attr}; @elements[:#{attr}].value; end\n" \
+                      "def #{attr}=(v); @elements[:#{attr}].value = v; end"
+          end
+        end
+
+        def known_headers
+          @known_headers ||= {}.freeze
         end
       end
 
@@ -37,7 +43,11 @@ module PacketGen
       # @param [String] str
       # @return [ASN1Base] self
       def read(str)
-        parse(str, ber: true)
+        begin
+          parse(str, ber: true)
+        rescue RASN1::ASN1Error
+          # suppress exception to allow guessing
+        end
         self
       end
 

data/lib/packetgen/header/base.rb

@@ -99,10 +99,8 @@ module PacketGen
 
         # each iterator
         # @return [void]
-        def each
-          @bindings.each do |b|
-            yield b
-          end
+        def each(&block)
+          @bindings.each(&block)
         end
 
         # @return [Boolean]
@@ -144,74 +142,74 @@ module PacketGen
         klass.class_eval { @known_headers = {} }
       end
 
-      # Bind a upper header to current one.
-      # @param [Class] header_klass header class to bind to current class
-      # @param [Hash] args current class fields and their value when +header_klass+
-      #   is embedded in current class.
-      #
-      #   Given value may be a lambda, whose alone argument is the value extracted
-      #   from header field (or +nil+ when lambda is used to set  field while adding
-      #   a header).
-      #
-      #   Special key +procs+ may be used to set 2 lambdas, the former to set
-      #   fields, the latter to check bindings. This may be used when multiple and
-      #   non-trivial checks should be made.
-      # @return [void]
-      # @example Basic examples
-      #   # Bind Header2 to Header1 when field1 from Header1 has a value of 42
-      #   Header1.bind Header2, field1: 42
-      #   # Bind Header3 to Header1 when field1 from Header1 has a value of 43
-      #   # and field2 has value 43 or 44
-      #   Header1.bind Header3, field1: 43, field2: 43
-      #   Header1.bind Header3, field1: 43, field2: 44
-      # @example Defining a binding on a field using a lambda.
-      #   # Bind Header4 to Header1 when field1 from Header1 has a value
-      #   # greater or equal to 44. When adding a Header2 to a Header1
-      #   # with Packet#add, force value to 44.
-      #   Header1.bind Header4, field1: ->(v) { v.nil? ? 44 : v >= 44 }
-      # @example Defining a binding using procs key
-      #   # Bind Header5 to Header1 when field1 from Header1 has a value of 41
-      #   # and first two bytes of header1's body are null.
-      #   # When adding a Header2 to a Header1 with Packet#add, force value to 44.
-      #   Header1.bind Header5, procs: [->(hdr) { hdr.field1 = 41 }
-      #                                 ->(hdr) { hdr.field1 == 41 && hdr.body[0..1] == "\x00\x00" }]
-      # @since 2.7.0
-      def self.bind(header_klass, args={})
-        if @known_headers[header_klass].nil?
-          bindings = Bindings.new
-          @known_headers[header_klass] = bindings
-        else
-          bindings = @known_headers[header_klass]
-        end
-        bindings.new_set
-        args.each do |key, value|
-          bindings << if key == :procs
-                        ProcBinding.new(value)
-                      else
-                        Binding.new(key, value)
-                      end
-        end
-      end
+      class <<self
+        # @api private
+        # Get known headers
+        # @return [Hash] keys: header classes, values: hashes
+        attr_reader :known_headers
 
-      # Helper method to calculate length of +hdr+ and set its +length+ field.
-      # To be used by +#calc_length+ in Base subclasses.
-      # @param [Base] hdr
-      # @param [Boolean] header_in_size if +true+ header is included in length,
-      #   if +false+, only +body+ is taken into account
-      def self.calculate_and_set_length(hdr, header_in_size: true)
-        length = if header_in_size
-                   hdr.sz
-                 else
-                   hdr[:body].sz
-                 end
-        hdr.length = length
-      end
+        # Bind a upper header to current one.
+        # @param [Class] header_klass header class to bind to current class
+        # @param [Hash] args current class fields and their value when +header_klass+
+        #   is embedded in current class.
+        #
+        #   Given value may be a lambda, whose alone argument is the value extracted
+        #   from header field (or +nil+ when lambda is used to set  field while adding
+        #   a header).
+        #
+        #   Special key +procs+ may be used to set 2 lambdas, the former to set
+        #   fields, the latter to check bindings. This may be used when multiple and
+        #   non-trivial checks should be made.
+        # @return [void]
+        # @example Basic examples
+        #   # Bind Header2 to Header1 when field1 from Header1 has a value of 42
+        #   Header1.bind Header2, field1: 42
+        #   # Bind Header3 to Header1 when field1 from Header1 has a value of 43
+        #   # and field2 has value 43 or 44
+        #   Header1.bind Header3, field1: 43, field2: 43
+        #   Header1.bind Header3, field1: 43, field2: 44
+        # @example Defining a binding on a field using a lambda.
+        #   # Bind Header4 to Header1 when field1 from Header1 has a value
+        #   # greater or equal to 44. When adding a Header2 to a Header1
+        #   # with Packet#add, force value to 44.
+        #   Header1.bind Header4, field1: ->(v) { v.nil? ? 44 : v >= 44 }
+        # @example Defining a binding using procs key
+        #   # Bind Header5 to Header1 when field1 from Header1 has a value of 41
+        #   # and first two bytes of header1's body are null.
+        #   # When adding a Header2 to a Header1 with Packet#add, force value to 44.
+        #   Header1.bind Header5, procs: [->(hdr) { hdr.field1 = 41 }
+        #                                 ->(hdr) { hdr.field1 == 41 && hdr.body[0..1] == "\x00\x00" }]
+        # @since 2.7.0
+        def bind(header_klass, args={})
+          if @known_headers[header_klass].nil?
+            bindings = Bindings.new
+            @known_headers[header_klass] = bindings
+          else
+            bindings = @known_headers[header_klass]
+          end
+          bindings.new_set
+          args.each do |key, value|
+            bindings << if key == :procs
+                          ProcBinding.new(value)
+                        else
+                          Binding.new(key, value)
+                        end
+          end
+        end
 
-      # @api private
-      # Get known headers
-      # @return [Hash] keys: header classes, values: hashes
-      def self.known_headers
-        @known_headers
+        # Helper method to calculate length of +hdr+ and set its +length+ field.
+        # To be used by +#calc_length+ in Base subclasses.
+        # @param [Base] hdr
+        # @param [Boolean] header_in_size if +true+ header is included in length,
+        #   if +false+, only +body+ is taken into account
+        def calculate_and_set_length(hdr, header_in_size: true)
+          length = if header_in_size
+                     hdr.sz
+                   else
+                     hdr[:body].sz
+                   end
+          hdr.length = length
+        end
       end
 
       # @see Types::Fields#initialize

data/lib/packetgen/header/dhcpv6/duid.rb

@@ -11,6 +11,8 @@ module PacketGen
       # @abstract Base class for DUID (DHCP Unique ID)
       # @author Sylvain Daubert
       class DUID < Types::Fields
+        include Types::Fieldable
+
         TYPES = {
           'DUID-LLT' => 1,
           'DUID-EN' => 2,
@@ -34,7 +36,7 @@ module PacketGen
         # @param [String] str
         # @return [DUID]
         def read(str)
-          if self.class == DUID
+          if self.instance_of?(DUID)
             super
             case type
             when 1

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

@@ -17,6 +17,8 @@ module PacketGen
       # field to replace it by specific option field(s).
       # @author Sylvain Daubert
       class Option < Types::Fields
+        include Types::Fieldable
+
         # @!attribute type
         #  16-bit option type
         #  @return [Integer]
@@ -85,7 +87,7 @@ module PacketGen
         # Get human-readable {#type}
         # @return [String]
         def human_type
-          if self.class == Option
+          if self.instance_of?(Option)
             "option#{type}"
           else
             self.class.to_s.sub(/.*::/, '')
@@ -230,17 +232,7 @@ module PacketGen
 
         # @!attribute options
         #   @return [RequestedOptions]
-        define_field :options, RequestedOptions
-
-        # Populate object from +str+
-        # @param [String] str
-        # @return [self]
-        def read(str)
-          self[:type].read str[0, 2]
-          self[:length].read str[2, 2]
-          self[:options].read str[4, self.length]
-          self
-        end
+        define_field :options, RequestedOptions, builder: ->(h, t) { t.new(length_from: h[:length]) }
 
         # Get human-readable data
         # @return [String]