packetgen 3.1.1 → 3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36578b725eb28ace342c6468423d781158b376c16bcc8b949e1df62262aba11a
-  data.tar.gz: 6e3bbdfc313f54611b05a19a31336438fa781cce24bc19867a2e72d91bbc8f9e
+  metadata.gz: d8959dbe60df80490d1ac31eaf40b05a206860bf6bed306997a66ca9c77dfb0b
+  data.tar.gz: 4615a1084f86e4b0ab216b3766dbde7d1b0b2b1e3c2e6b0d2e1a63aba1ff7bd6
 SHA512:
-  metadata.gz: 64cfe76137b2f4f2ea1b75806019a28d63d32cb904fe3a22982d8cf5b090e3df74befd527606d250d49a2541842b2dba2c0e1060b61128ecd538b2c6c7e6d544
-  data.tar.gz: 9700b4a0f455d5b6918d8a0eac2309100e29db650eb2f88469a54241b8b5888d2605571883aaebe187d69db97c0e0e380ba35c4325a6bd420c492ec7dc619c55
+  metadata.gz: 636f0dcea926b57cb7ec7a824744dfbcab9c6ddbb7f6749d8fda8f63fec410d20dcf199f362ae63878104725e94c7075d17f94b3f0dc8458b3d975e9521343da
+  data.tar.gz: 50e679400b1f882fbe2d3bc9e3ba5e01bb24dbe4a83b3372b999cbe0d1565703a7fc6afc08c437900e23b92c549c46ad422e3e76140254034c8840ba3a8ecb2e

data/bin/pgconsole

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

data/lib/packetgen.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # This file is part of PacketGen
 # See https://github.com/sdaubert/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 require 'packetgen/version'
 require 'interfacez'
 
@@ -24,6 +24,27 @@ module PacketGen
   # Sending packet on wire error
   class WireError < Error; end
 
+  # No known binding
+  class BindingError < Error
+    # @return [Headerable]
+    attr_reader :prev_hdr
+    # @return [Headerable]
+    attr_reader :hdr
+
+    def initialize(prev_hdr, hdr)
+      super()
+      @prev_hdr = prev_hdr
+      @hdr = hdr
+    end
+
+    def message
+      "#{prev_hdr.class} knowns no layer association with #{hdr.protocol_name}. " \
+          "Try #{prev_hdr.class}.bind_layer(#{hdr.class}, " \
+          "#{prev_hdr.method_name}_proto_field: " \
+          "<value_for_#{hdr.method_name}>)"
+    end
+  end
+
   # Shortcut for {Packet.gen}
   # @param [String] protocol base protocol for packet
   # @param [Hash] options specific options for +protocol+
@@ -46,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}
@@ -77,6 +98,12 @@ module PacketGen
     Interfacez.default
   end
 
+  # Get loopback network interface
+  # @return [String]
+  def self.loopback_iface
+    Interfacez.loopback
+  end
+
   # Shortcut to get a header class
   # @example builtin class
   #   # same as PacketGen::Header::Dot11:Data.new(id: 0xfedc)
@@ -94,9 +121,11 @@ 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/capture'
+require 'packetgen/inject'
 require 'packetgen/proto'

data/lib/packetgen/capture.rb

@@ -1,21 +1,21 @@
+# frozen_string_literal: true
+
 # This file is part of PacketGen
 # See https://github.com/sdaubert/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
-
-# frozen_string_literal: true
+require_relative 'pcaprub_wrapper'
 
 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
-
     private
 
-    attr_reader :filter, :cap_thread
+    attr_reader :filter, :cap_thread, :snaplen, :promisc, :monitor
+
+    # rubocop:disable Metrics/ParameterLists
 
     public
 
@@ -43,37 +43,34 @@ 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 nor more a hash
-    def initialize(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: DEFAULT_SNAPLEN)
-      @iface = iface || Interfacez.default || Interfacez.loopback
+    # @since 3.0.0 arguments are kwargs and no more a hash
+    # @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
     # @see {#initialize} for parameters
     # @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 nor more a hash
-    def start(iface: nil, max: nil, timeout: nil, filter: nil, promisc: false, parse: true, snaplen: DEFAULT_SNAPLEN)
-      set_options iface, max, timeout, filter, promisc, parse, snaplen
-
-      pcap = PCAPRUB::Pcap.open_live(self.iface, @snaplen, @promisc, 1)
-      set_filter_on pcap
+    # @since 3.0.0 arguments are kwargs and no more a hash
+    # @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
-        pcap.each do |packet_data|
-          raw_packets << packet_data
-          if @parse
-            packet = Packet.parse(packet_data)
-            packets << packet
-            yield packet if block_given?
-          elsif block_given?
-            yield packet_data
-          end
+        PCAPRUBWrapper.capture(**capture_args) do |packet_data|
+          add_packet(packet_data, &block)
           break if defined?(@max) && (raw_packets.size >= @max)
         end
       end
@@ -91,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?
@@ -99,12 +99,35 @@ 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, monitor: monitor }
+      h[:snaplen] = snaplen unless snaplen.nil?
+      h[:promisc] = promisc unless promisc.nil?
+      h
     end
 
-    def set_filter_on(pcap)
+    def filter_on(pcap)
       return if filter.nil? || filter.empty?
 
-      pcap.setfilter filter
+      PCAPRUBWrapper.filter_on(pcap: pcap, filter: filter)
+    end
+
+    def add_packet(data, &block)
+      raw_packets << data
+      if @parse
+        packet = Packet.parse(data)
+        packets << packet
+        block&.call(packet)
+      elsif block
+        yield data
+      end
     end
   end
 end

data/lib/packetgen/config.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of PacketGen
 # See https://github.com/sdaubert/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 require 'socket'
 require 'singleton'
 
@@ -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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PacketGen
   # Deprecation module
   # @since 2.7.0
@@ -8,6 +10,14 @@ module PacketGen
     # @since 3.1.0
     REMOVE_VERSION = '4.0.0'
 
+    # @private
+    # @param [String] remove_version
+    # @return [String]
+    # @since 3.1.4
+    def self.removed(remove_version)
+      "It will be removed in PacketGen #{remove_version}"
+    end
+
     # Warn when using a deprecated method
     # @param [Module] klass class/module of deprecated method
     # @param [Symbol,String] deprecated_method
@@ -17,15 +27,14 @@ module PacketGen
     # @param [String] remove_version version from which +deprecated_method+ will
     #                 no more exist.
     def self.deprecated(klass, deprecated_method, new_method=nil, klass_method: false, remove_version: REMOVE_VERSION)
-      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 unless new_method.nil?
+      base_name = "#{klass}#{klass_method ? '.' : '#'}"
+      complete_deprecated_method_name = "#{base_name}#{deprecated_method}"
+      complete_new_method_name = "#{base_name}#{new_method}" unless new_method.nil?
 
-      file, line = caller(2).first.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 << ". It will be remove in PacketGen #{remove_version}."
+      message << '. ' << self.removed(remove_version)
       warn message
     end
 
@@ -38,8 +47,25 @@ module PacketGen
     def self.deprecated_class(klass, new_klass=nil, remove_version: REMOVE_VERSION)
       file, line = caller(2..2).first.split(':')[0, 2]
       message = +"#{file}:#{line}: #{klass} is deprecated"
-      message << " in favor od #{new_klass}" unless new_klass.nil?
-      message << ". It will be remove in PacketGen #{remove_version}."
+      message << " in favor of #{new_klass}" unless new_klass.nil?
+      message << '. ' << self.removed(remove_version)
+      warn message
+    end
+
+    # Warn when using a deprecated method's option
+    # @param [Module] klass deprecated class/module
+    # @param [Module] method method name
+    # @param [Symbol] option option name
+    # @param [Boolean] klass_method +deprecated_method+ is a class method (+true+)
+    #                  or a, instance one (+false+)
+    # @param [String] remove_version version from which +klass+ will
+    #                 no more exist.
+    # @since 3.1.4
+    def self.deprecated_option(klass, method, option, klass_method: false, remove_version: REMOVE_VERSION)
+      base_name = "#{klass}#{klass_method ? '.' : '#'}"
+      method_name = "#{base_name}#{method}"
+      message = +"option #{option} is deprecated for method #{method_name}. "
+      message << self.removed(remove_version)
       warn message
     end
   end

data/lib/packetgen/header.rb

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # This file is part of PacketGen
 # See https://github.com/sdaubert/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen
   # Namespace for protocol header classes.
   #
@@ -30,13 +30,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
-    PCAP_PROMISC = false
-    # @private timeout for PCAPRUB
-    PCAP_TIMEOUT = 1
-
     @added_header_classes = {}
 
     class << self

data/lib/packetgen/header/arp.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of PacketGen
 # See https://github.com/sdaubert/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen
   module Header
     # An ARP header consists of:

data/lib/packetgen/header/asn1_base.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of PacketGen
 # See https://github.com/sdaubert/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 require 'rasn1'
 
 module PacketGen

data/lib/packetgen/header/base.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # This file is part of PacketGen
 # See https://github.com/sdaubert/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
 module PacketGen
   module Header
     # @abstract Base class for all header types.
@@ -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,75 +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
 
+        # 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
 
-      # 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
-
-      # @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
@@ -221,7 +218,6 @@ module PacketGen
         super
       end
 
-
       # @api private
       # Get +header+ id in {Packet#headers} array
       # @param [Header] header