packetgen 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79dc573da10eb15bbd9f38e0c84ecdf9a92d076980628635d1b9e240e3ca2210
-  data.tar.gz: 0ae2bafa08e5a4a0b176276a141b8c8326265873bb20d86a75e07bb7018275ac
+  metadata.gz: ad942df146df9daf8c38e049fc112b13c93fd38a45362e8dd2a43c6e8382b224
+  data.tar.gz: 77b48a6af0170a912e91b888456c31881bfe1fd30a693796c849a946b5e27bac
 SHA512:
-  metadata.gz: 7c405a57b79c4a9bf0d9032b34d7381b33e8c0705c554023f6a8131c19c48fb0118201d94da62e4f74b9d53551cdbcd434cb6363f27a84e5c3e8459cb28d613b
-  data.tar.gz: 835969235415864e05b227dd5f0fb48535e3f414e60852cf788d6d90bf29be9a3a8dcf9b636ce8d500d29720753246e11459da925fea3f72f6cb8e11291565b8
+  metadata.gz: 98f7f9d7dd652741cdce08cbe081310c4f4ca6745702efc5755806614f30c7930498610f9925a6d7abeef1b8b64abfa2857c77bcc638872f31577fe587ad1e63
+  data.tar.gz: cc4e18519b09f7eaa753f9f2e4a500c5b3d0de2aed5bbd275b636d5c21ec763dca2a34da27a16336d65e2ec86d827812c0f546c5e67dfd9b500d683f8baac7ac

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

@@ -58,6 +58,12 @@ module PacketGen
         def to_human
           "DUID<#{type},#{body.inspect}>"
         end
+
+        # Get human-readable type
+        # @return [String]
+        def human_type
+          self[:type].to_human
+        end
       end
 
       # rubocop:disable Naming/ClassAndModuleCamelCase

data/lib/packetgen/header/http/headers.rb

@@ -34,13 +34,28 @@ module PacketGen
 
               k, v = h.split(':', 2)
               [k, v.strip]
-            end.reject(&:nil?).to_h
+            end.compact.to_h
           when Hash
             @data = s_or_h
           end
           self
         end
 
+        # Get header value from its name
+        # @param [String] header header name
+        # @return [String] header value
+        def [](header)
+          data[header]
+        end
+
+        # Say if +self+ include +header+ header
+        # @param [String] header header name
+        # @return [Boolean]
+        def header?(header)
+          data.key?(header)
+        end
+        alias has_header? header?
+
         # Get binary string.
         # @return [String]
         def to_s

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

@@ -86,25 +86,23 @@ module PacketGen
         # Factory to build an option from its type
         # @return [Option]
         def self.build(options={})
-          type = options.delete(:type)
+          type = options[:type]
           klass = case type
                   when String
                     types.key?(type) ? IP.const_get(type) : self
-                  when Integer
-                    types.value?(type) ? IP.const_get(types.key(type)) : self
                   else
-                    self
+                    types.value?(type) ? IP.const_get(types.key(type.to_i)) : self
                   end
+          options.delete(:type) if klass != self
           klass.new(options)
         end
 
         def initialize(options={})
-          unless options[:type]
-            opt_name = self.class.to_s.gsub(/.*::/, '')
-            options[:type] = Option.const_get("#{opt_name}_TYPE") if Option.const_defined? "#{opt_name}_TYPE"
-          end
+          options[:type] = class2type unless options[:type]
+
           super
-          self.length = sz if respond_to?(:length) && options[:length].nil?
+          initialize_length_if_needed(options)
+          initialize_data_if_needed(options)
         end
 
         # Get binary string. Set {#length} field.
@@ -121,6 +119,25 @@ module PacketGen
           str << ":#{self[:data].to_s.inspect}" if respond_to?(:length) && (length > 2) && !self[:data].to_s.empty?
           str
         end
+
+        private
+
+        def class2type
+          opt_name = self.class.to_s.gsub(/.*::/, '')
+          Option.const_get("#{opt_name}_TYPE") if Option.const_defined? "#{opt_name}_TYPE"
+        end
+
+        def initialize_length_if_needed(options)
+          self.length = sz if respond_to?(:length) && options[:length].nil?
+        end
+
+        def initialize_data_if_needed(options)
+          return unless fields.include?(:data) && self[:data].respond_to?(:from_human) && options.key?(:data)
+
+          # Force data if data is set in options but not length
+          self.length += options[:data].size
+          self[:data].from_human(options[:data])
+        end
       end
 
       # End-of-option-List IP option
@@ -173,6 +190,10 @@ module PacketGen
         #  16-bit stream ID
         #  @return [Integer]
         define_field :id, Types::Int16
+
+        def to_human
+          super << ":#{self.id}"
+        end
       end
 
       # Router Alert IP option
@@ -183,6 +204,10 @@ module PacketGen
         #  16-bit value. Should be 0.
         #  @return [Integer]
         define_field :value, Types::Int16, default: 0
+
+        def to_human
+          super << ":#{self.value}"
+        end
       end
     end
   end

data/lib/packetgen/header/snmp.rb

@@ -74,6 +74,18 @@ module PacketGen
       # @author Sylvain Daubert
       class VariableBindings < RASN1::Model
         sequence_of :bindings, VarBind
+
+        # Get 'idx'th element from the list
+        # @return [VarBind,nil]
+        def [](idx)
+          value[idx]
+        end
+
+        # Get element counts in list
+        # @return [Integer]
+        def size
+          value.size
+        end
       end
 
       # Class to handle GetRequest PDU
@@ -119,6 +131,10 @@ module PacketGen
                            integer(:error, value: 0, enum: ERRORS),
                            integer(:error_index, value: 0),
                            model(:varbindlist, VariableBindings)]
+
+        def initialize(args={})
+          super
+        end
       end
 
       # Class to handle GetNextRequest PDU
@@ -264,11 +280,12 @@ module PacketGen
         data.chosen = options[:chosen_pdu] if options[:chosen_pdu]
         return unless options[:pdu]
 
-        data.root.value[data.chosen] = data.root.chosen_value.class.new(options[:pdu])
+        klass = data.root.chosen_value.class
+        data.root.value[data.chosen] = klass.new(options[:pdu])
       end
 
       # accessor to data payload
-      # @return [GetRequest]
+      # @return [ASN1::Types::Choice]
       def data
         @elements[:data]
       end

data/lib/packetgen/types/array.rb

@@ -154,26 +154,19 @@ module PacketGen
         self
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
-
-      # Populate object from a string
-      # @param [String] str
+      # Populate object from a string or from an array of hashes
+      # @param [String, Array<Hash>] data
       # @return [self]
-      def read(str)
+      def read(data)
         clear
-        return self if str.nil?
-        return self if @counter&.to_i&.zero?
-
-        str = read_with_length_from(str)
-        until str.empty?
-          obj = create_object_from_str(str)
-          @array << obj
-          str.slice!(0, obj.sz)
-          break if @counter && self.size == @counter.to_i
+        case data
+        when ::Array
+          read_from_array(data)
+        else
+          read_from_string(data)
         end
         self
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Get size in bytes
       # @return [Integer]
@@ -201,6 +194,28 @@ module PacketGen
 
       private
 
+      # rubocop:disable Metrics/CyclomaticComplexity
+
+      def read_from_string(str)
+        return self if str.nil? || @counter&.to_i&.zero?
+
+        str = read_with_length_from(str)
+        until str.empty? || (@counter && self.size == @counter.to_i)
+          obj = create_object_from_str(str)
+          @array << obj
+          str.slice!(0, obj.sz)
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def read_from_array(ary)
+        return self if ary.empty?
+
+        ary.each do |hsh|
+          self << hsh
+        end
+      end
+
       def record_from_hash(hsh)
         obj_klass = self.class.set_of_klass
         raise NotImplementedError, 'class should define #record_from_hash or declare type of elements in set with .set_of' unless obj_klass

data/lib/packetgen/unknown_packet.rb

@@ -61,7 +61,8 @@ module PacketGen
 
     # @return [String]
     def inspect
-      # TODO
+      str = Inspect.dashed_line(self.class)
+      str << Inspect.inspect_body(body)
     end
 
     # equality if {#to_s} is equal
@@ -74,7 +75,7 @@ module PacketGen
     # @return [Boolean]
     def ===(other)
       case other
-      when UnknwonPacket
+      when UnknownPacket
         self == other
       else
         false

data/lib/packetgen/utils.rb

@@ -25,23 +25,32 @@ module PacketGen
                   ' (ip dst %<target2>s and not ip src %<local_ip>s))' \
                   ' and ether dst %<local_mac>s'
 
+    # @private
+    ARP_PATH = '/usr/sbin/arp'
+    # @private
+    IP_PATH = '/usr/bin/ip'
+    # @private
+    ARP_LINE_RE = /\((\d+\.\d+\.\d+\.\d+)\) at (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})(?: \[ether\])? on (\w+)/.freeze
+    # @private
+    IP_LINE_RE = /^(\d+\.\d+\.\d+\.\d+) dev (\w+) lladdr (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})/.freeze
+
     # Get local ARP cache
     # @return [Hash] key: IP address, value: array containing MAC address and
     #    interface name
     def self.arp_cache
-      return self.cache_from_arp_command if File.exist?('/usr/sbin/arp')
-      return self.cache_from_ip_command if File.exist?('/usr/bin/ip')
+      return self.cache_from_arp_command if File.exist?(ARP_PATH)
+      return self.cache_from_ip_command if File.exist?(IP_PATH)
 
       {}
     end
 
     # @private
-    def self.cache_from_arp_command
-      raw_cache = `/usr/sbin/arp -an`
+    def self.cache_from_arp_command(raw_cache=nil)
+      raw_cache ||= `#{ARP_PATH} -an`
 
       cache = {}
       raw_cache.split("\n").each do |line|
-        match = line.match(/\((\d+\.\d+\.\d+\.\d+)\) at (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})(?: \[ether\])? on (\w+)/)
+        match = line.match(ARP_LINE_RE)
         cache[match[1]] = [match[2], match[4]] if match
       end
 
@@ -49,12 +58,12 @@ module PacketGen
     end
 
     # @private
-    def self.cache_from_ip_command
-      raw_cache = `ip neigh`
+    def self.cache_from_ip_command(raw_cache=nil)
+      raw_cache ||= `#{IP_PATH} neigh`
 
       cache = {}
       raw_cache.split("\n").each do |line|
-        match = line.match(/^(\d+\.\d+\.\d+\.\d+) dev (\w+) lladdr (([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2})/)
+        match = line.match(IP_LINE_RE)
         cache[match[1]] = [match[3], match[2]] if match
       end
 
@@ -155,7 +164,7 @@ module PacketGen
     #   end
     # @since 2.2.0
     # @raise [RuntimeError] user don't have permission to capture packets on network device.
-    def self.mitm(target1, target2, options={})
+    def self.mitm(target1, target2, options={}, &block)
       options = { iface: PacketGen.default_iface }.merge(options)
 
       spoofer = Utils::ARPSpoofer.new(options)
@@ -168,7 +177,7 @@ module PacketGen
                             filter: MITM_FILTER % { target1: target1, target2: target2, local_ip: cfg.ipaddr(options[:iface]), local_mac: my_mac })
 
       spoofer.start_all
-      mitm_core(capture, target1, target2, my_mac, &proc)
+      mitm_core(capture, target1, target2, my_mac, &block)
       spoofer.stop_all
     end
 

data/lib/packetgen/version.rb

@@ -10,5 +10,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '3.2.1'
+  VERSION = '3.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez