packetgen 3.1.3 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4bbe2b2ffd9d59d7fc57ac668744bd794deafa09b813fb7834588da9a571b64
-  data.tar.gz: 24ac8e7feb4d0ad95aee6fb52f3ab53e8f0304e35991428e8fafba04002ceeaf
+  metadata.gz: 2adf2b07c2d2d334e4f0ae6e4e7b49571d4d436788bef51df6cf7c1a5aaba9c8
+  data.tar.gz: 8997321a31379ea6952ab42a4642d98a717587ed777652ebdb9e25b5928cc8d4
 SHA512:
-  metadata.gz: 961b3c05d1d18c61c1b55042500a73f136654f612c05a8749e18b2d294517b23dde7f3c8fb0ac0e1fdf9bfc672b6b0535aa64e5f90fa156eb88d1a74a095a358
-  data.tar.gz: 2d274501fa186766775374ad4c8d24c46a646dd3422d1da6930c96426c3e861f7f7cdd04f8cd5e1308b7237fa45679ad669e4503705121d97e6e9562f2a5c9c9
+  metadata.gz: b5af6e0d04f8bb03af01d63cde3879a6a13c8a78477811be2b95fee5c597820f4714f8ac8b69f4aa8f04d3d5b81c5e25b5787815ee2237a8c3329721b5dc7895
+  data.tar.gz: 6eebb203f8dfde49505987d16778c1ecbc81c463d6ac8b5f005e2c6f486166ba0cceabd848d3b3aeebe867b138993171026e8dcacfb04c84a126bc149ff5c616

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,26 @@ 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)
+      @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+
@@ -97,6 +117,8 @@ require 'packetgen/deprecation'
 require 'packetgen/types'
 require 'packetgen/inspect'
 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,19 @@
+# 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
 
     public
 
@@ -44,8 +42,8 @@ module PacketGen
     # @param [Integer] snaplen maximum number of bytes to capture for
     #    each packet.
     # @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)
+    # @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
 
       @packets     = []
@@ -57,23 +55,13 @@ module PacketGen
     # @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)
+    # @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
 
-      pcap = PCAPRUB::Pcap.open_live(self.iface, @snaplen, @promisc, 1)
-      set_filter_on pcap
-
       @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
@@ -101,10 +89,28 @@ module PacketGen
       @iface = iface unless iface.nil?
     end
 
-    def set_filter_on(pcap)
+    def capture_args
+      h = { iface: iface, filter: filter }
+      h[:snaplen] = snaplen unless snaplen.nil?
+      h[:promisc] = promisc unless promisc.nil?
+      h
+    end
+
+    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'
 

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).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
 
@@ -39,7 +48,24 @@ module PacketGen
       file, line = caller(2..2).first.split(':')[0, 2]
       message = +"#{file}:#{line}: #{klass} is deprecated"
       message << " in favor of #{new_klass}" unless new_klass.nil?
-      message << ". It will be remove in PacketGen #{remove_version}."
+      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.
@@ -193,7 +193,6 @@ module PacketGen
         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
@@ -221,7 +220,6 @@ module PacketGen
         super
       end
 
-
       # @api private
       # Get +header+ id in {Packet#headers} array
       # @param [Header] header

data/lib/packetgen/header/bootp.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
     # Bootstrap Protocol, {https://tools.ietf.org/html/rfc951
@@ -45,7 +45,7 @@ module PacketGen
       # DHCP opcodes
       OPCODES = {
         'BOOTREQUEST' => 1,
-        'BOOTREPLY'   => 2
+        'BOOTREPLY' => 2
       }.freeze
 
       # @!attribute op

data/lib/packetgen/header/dhcp.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
     # Dynamic Host Configuration Protocol, {https://tools.ietf.org/html/rfc2131

data/lib/packetgen/header/dhcp/option.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
     class DHCP

data/lib/packetgen/header/dhcp/options.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
     class DHCP

data/lib/packetgen/header/dhcpv6.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
     # Dynamic Host Configuration Protocol for IPv6, {https://tools.ietf.org/html/rfc3315
@@ -55,16 +55,16 @@ module PacketGen
 
       # DHCPv6 message types
       MESSAGE_TYPES = {
-        'SOLLICIT'            => 1,
-        'ADVERTISE'           => 2,
-        'REQUEST'             => 3,
-        'CONFIRM'             => 4,
-        'RENEW'               => 5,
-        'REBIND'              => 6,
-        'REPLY'               => 7,
-        'RELEASE'             => 8,
-        'DECLINE'             => 9,
-        'RECONFIGURE'         => 10,
+        'SOLLICIT' => 1,
+        'ADVERTISE' => 2,
+        'REQUEST' => 3,
+        'CONFIRM' => 4,
+        'RENEW' => 5,
+        'REBIND' => 6,
+        'REPLY' => 7,
+        'RELEASE' => 8,
+        'DECLINE' => 9,
+        'RECONFIGURE' => 10,
         'INFORMATION-REQUEST' => 11
       }.freeze
 

data/lib/packetgen/header/dhcpv6/duid.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
     class DHCPv6
@@ -13,8 +13,8 @@ module PacketGen
       class DUID < Types::Fields
         TYPES = {
           'DUID-LLT' => 1,
-          'DUID-EN'  => 2,
-          'DUID-LL'  => 3
+          'DUID-EN' => 2,
+          'DUID-LL' => 3
         }.freeze
 
         # @!attribute type
@@ -58,6 +58,8 @@ module PacketGen
         end
       end
 
+      # rubocop:disable Naming/ClassAndModuleCamelCase
+
       # DUID Based on Link-layer Address Plus Time
       # @author Sylvain Daubert
       class DUID_LLT < DUID
@@ -140,3 +142,5 @@ module PacketGen
     end
   end
 end
+
+# rubocop:enable Naming/ClassAndModuleCamelCase