packetgen 3.1.5 → 3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 476cbc2bd2b9fb254ea40fe0a07a4d703a0fc36e4accc823de7e83b640d95a2d
-  data.tar.gz: 375f31ea90589b2b0c0b257b8a3efaa66715e8b369c542124fe3dcac283d9221
+  metadata.gz: d8959dbe60df80490d1ac31eaf40b05a206860bf6bed306997a66ca9c77dfb0b
+  data.tar.gz: 4615a1084f86e4b0ab216b3766dbde7d1b0b2b1e3c2e6b0d2e1a63aba1ff7bd6
 SHA512:
-  metadata.gz: c518ff72cf70227c8f9ef38cce97ba5036eb3229051d38172ba947898b9051f508670d1e0106bac0f5edf577fe1450d5f71db557aa6968b7e3998945a87177d7
-  data.tar.gz: 9382d6f8a7542c8988dec0aaf92940f1518885133bf9e7c835478e787546309410c7e7bcfb4525c13fb7479a9cad9a7ece3e30a3d3c6bbb4f081c1cc48b7f02e
+  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

@@ -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}
@@ -121,7 +122,6 @@ end
 
 require 'packetgen/deprecation'
 require 'packetgen/inspect'
-require 'packetgen/inspectable'
 require 'packetgen/types'
 require 'packetgen/pcapng'
 require 'packetgen/pcap'

data/lib/packetgen/capture.rb

@@ -15,6 +15,8 @@ module PacketGen
 
     attr_reader :filter, :cap_thread, :snaplen, :promisc, :monitor
 
+    # rubocop:disable Metrics/ParameterLists
+
     public
 
     # Get captured packets.
@@ -86,6 +88,9 @@ module PacketGen
 
     private
 
+    # 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?
@@ -97,6 +102,10 @@ module PacketGen
       @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?

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(/.*::/, '')

data/lib/packetgen/header/dns/name.rb

@@ -43,28 +43,32 @@ module PacketGen
           self << Types::IntString.new
         end
 
+        # Clear name
+        #   @return [void]
+        def clear
+          super
+          @pointer = nil
+          @pointer_name = nil
+        end
+
         # Read a sequence of label from a string
         # @param [String] str binary string
         # @return [Name] self
         def read(str)
-          @pointer = nil
-          @pointer_name = nil
           clear
           return self if str.nil?
 
           PacketGen.force_binary str
           start = 0
           loop do
-            index = str[start, 2].unpack('n').first
+            index = str[start, 2].unpack1('n')
             if pointer? index
               # Pointer on another label
               @pointer = str[start, 2]
               break
             else
-              label = Types::IntString.new
-              label.read(str[start..-1])
+              label = add_label_from(str[start..-1])
               start += label.sz
-              self << label
               break if label.length.zero? || str[start..-1].length.zero?
             end
           end
@@ -101,7 +105,7 @@ module PacketGen
           return nil unless @pointer
           return @pointer_name if @pointer_name
 
-          index = @pointer.unpack('n').first
+          index = @pointer.unpack1('n')
           mask = ~POINTER_MASK & 0xffff
           ptr = index & mask
           name = Name.new
@@ -112,6 +116,13 @@ module PacketGen
         def record_from_hash(_hsh)
           raise NotImplementedError, "not supported by #{self.class}"
         end
+
+        def add_label_from(str)
+          label = Types::IntString.new
+          label.read(str)
+          self << label
+          label
+        end
       end
     end
   end

data/lib/packetgen/header/dns/question.rb

@@ -11,6 +11,8 @@ module PacketGen
       # DNS Question
       # @author Sylvain Daubert
       class Question < Types::Fields
+        include Types::Fieldable
+
         # Ressource Record types
         TYPES = {
           'A' => 1,

data/lib/packetgen/header/dot11.rb

@@ -280,7 +280,7 @@ module PacketGen
       def read(str)
         fcs = Dot11.fcs?
 
-        if self.class == Dot11
+        if self.instance_of? Dot11
           return self if str.nil?
 
           force_binary str
@@ -323,7 +323,7 @@ module PacketGen
 
       # @return [String]
       def inspect
-        str = if self.class == Dot11
+        str = if self.instance_of? Dot11
                 Inspect.dashed_line("#{self.class} #{human_type}", 1)
               elsif self.respond_to? :human_subtype
                 Inspect.dashed_line("#{self.class} #{human_subtype}", 1)
@@ -360,27 +360,44 @@ module PacketGen
 
       private
 
-      def define_applicable_fields
+      def remove_from_applicable_fields(fields)
+        fields = [fields] unless fields.is_a? Array
+        @applicable_fields -= fields
+      end
+
+      def handle_mac4
         if to_ds? && from_ds?
           @applicable_fields[6, 0] = :mac4 unless @applicable_fields.include? :mac4
         else
-          @applicable_fields -= %i[mac4]
+          remove_from_applicable_fields :mac4
         end
+      end
+
+      def handle_ht_ctrl
         if order?
           unless @applicable_fields.include? :ht_ctrl
             idx = @applicable_fields.index(:body)
             @applicable_fields[idx, 0] = :ht_ctrl
           end
         else
-          @applicable_fields -= %i[ht_ctrl]
+          remove_from_applicable_fields %i[ht_ctrl]
         end
+      end
+
+      def handle_fcs
         if Dot11.fcs?
           @applicable_fields << :fcs unless @applicable_fields.include? :fcs
         else
-          @applicable_fields -= %i[fcs]
+          remove_from_applicable_fields :fcs
         end
       end
 
+      def define_applicable_fields
+        handle_mac4
+        handle_ht_ctrl
+        handle_fcs
+      end
+
       def private_read(str, fcs)
         self[:frame_ctrl].read str[0, 2]
         define_applicable_fields

data/lib/packetgen/header/dot11/data.rb

@@ -44,22 +44,22 @@ module PacketGen
           case ds
           when 0
             # MAC1: RA/DA, MAC2: TA/SA
-            self[:mac1], self[:mac2] = self[:mac2], self[:mac1]
+            invert_mac :mac1, :mac2
           when 1
             # MAC1: RA/BSSID, MAC2: TA/SA, MAC3: DA
-            self[:mac2], self[:mac1] = self[:mac1], self[:mac2]
+            invert_mac :mac1, :mac2
             self.to_ds = false
             self.from_ds = true
           when 2
             # MAC1: RA/DA, MAC2: BSSID, MAC3: SA or BSSID
-            self[:mac1], self[:mac2] = self[:mac2], self[:mac1]
+            invert_mac :mac1, :mac2
             self.to_ds = true
             self.from_ds = false
           when 3
             # MAC1: RA, MAC2: TA
-            self[:mac1], self[:mac2] = self[:mac2], self[:mac1]
+            invert_mac :mac1, :mac2
             # MAC3: DA, MAC4: SA
-            self[:mac4], self[:mac3] = self[:mac3], self[:mac4]
+            invert_mac :mac3, :mac4
           end
           self
         end
@@ -135,6 +135,10 @@ module PacketGen
             @applicable_fields -= %i[qos_ctrl]
           end
         end
+
+        def invert_mac(mac1, mac2)
+          self[mac1], self[mac2] = self[mac2], self[mac1]
+        end
       end
     end
   end

data/lib/packetgen/header/eap.rb

@@ -95,7 +95,8 @@ module PacketGen
       #  This field is present only for Request or Response packets,
       #  with type different from Expanded Types (254).
       #  @return [Integer] 8-bit request or response type
-      define_field :type, Types::Int8Enum, enum: TYPES,
+      define_field :type, Types::Int8Enum,
+                   enum: TYPES,
                    optional: ->(eap) { eap.type? }
 
       # @!attribute vendor_id
@@ -131,7 +132,7 @@ module PacketGen
       #   may be determined
       def read(str)
         super str
-        return self unless self.class == EAP
+        return self unless self.instance_of?(EAP)
         return self unless type?
 
         case self.type