packetgen 3.1.4 → 3.2.0

data/lib/packetgen/types/int.rb

@@ -12,6 +12,8 @@ module PacketGen
     # @abstract
     # @author Sylvain Daubert
     class Int
+      include Fieldable
+
       # Integer value
       # @return [Integer]
       attr_accessor :value
@@ -45,7 +47,7 @@ module PacketGen
         @value = if value.is_a?(Integer)
                    value.to_i
                  elsif defined? @packstr
-                   value.to_s.unpack(@packstr[@endian]).first
+                   value.to_s.unpack1(@packstr[@endian])
                  else
                    raise ParseError, 'Int#read is abstract and cannot read'
                  end
@@ -80,6 +82,18 @@ module PacketGen
       def sz
         width
       end
+
+      # Format Int type when inspecting header or packet
+      # @return [String]
+      def format_inspect
+        format_str % [to_i.to_s, to_i]
+      end
+
+      private
+
+      def format_str
+        "%-16s (0x%0#{width * 2}x)"
+      end
     end
 
     # One byte unsigned integer

data/lib/packetgen/types/int_string.rb

@@ -12,6 +12,8 @@ module PacketGen
     # By default, a null string will have one byte length (length byte set to 0).
     # @author Sylvain Daubert
     class IntString
+      include Fieldable
+
       # internal string
       # @return [String]
       attr_reader :string
@@ -88,6 +90,12 @@ module PacketGen
       def sz
         to_s.size
       end
+
+      # Say if IntString is empty
+      # @return [Boolean]
+      def empty?
+        length.zero?
+      end
     end
   end
 end

data/lib/packetgen/types/length_from.rb

@@ -14,6 +14,9 @@ module PacketGen
     # @author Sylvain Daubert
     # @since 3.0.0
     module LengthFrom
+      # Max value returned by {#sz_to_read}.
+      MAX_SZ_TO_READ = 65_535
+
       # Initialize +length from+ capacity.
       # Should be call by extensed object's initialize.
       # @param [Hash] options
@@ -29,16 +32,21 @@ module PacketGen
       # @return [String]
       def read_with_length_from(str)
         s = PacketGen.force_binary(str.to_s)
-        str_end = case @length_from
-                  when Types::Int
-                    @length_from.to_i
-                  when Proc
-                    @length_from.call
-                  else
-                    s.size
-                  end
-        str_end = 0 if str_end.negative?
-        s[0, str_end]
+        s[0, sz_to_read]
+      end
+
+      # Size to read, from length_from
+      # @return [Integer]
+      def sz_to_read
+        len = case @length_from
+              when Types::Int
+                @length_from.to_i
+              when Proc
+                @length_from.call
+              else
+                MAX_SZ_TO_READ
+              end
+        [0, len].max
       end
     end
   end

data/lib/packetgen/types/oui.rb

@@ -14,6 +14,8 @@ module PacketGen
     #  oui.to_human   # => "00:01:02"
     # @author Sylvain Daubert
     class OUI < Types::Fields
+      include Fieldable
+
       # @attribute b2
       #  @return [Integer] left-most byte
       define_field :b2, Types::Int8

data/lib/packetgen/types/string.rb

@@ -6,15 +6,24 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+require 'forwardable'
+
 module PacketGen
   module Types
-    # This class is just like regular String. It only adds {#read}, {#sz},
-    # #{to_human} and {#from_human} methods
-    # to be compatible with others {Types}.
+    # This class mimics regular String, but it is {Fieldable}.
     # @author Sylvain Daubert
-    class String < ::String
+    # @since 3.1.6 no more a subclass or regular String
+    class String
+      extend Forwardable
+      include Fieldable
       include LengthFrom
 
+      def_delegators :@string, :[], :to_s, :length, :size, :inspect, :==,
+                     :unpack, :force_encoding, :encoding, :index, :empty?,
+                     :encode, :slice, :slice!, :[]=
+
+      # @return [::String]
+      attr_reader :string
       # @return [Integer]
       attr_reader :static_length
 
@@ -23,23 +32,65 @@ module PacketGen
       #   takes length when reading
       # @option options [Integer] :static_length set a static length for this string
       def initialize(options={})
-        super()
+        register_internal_string(+'')
         initialize_length_from(options)
         @static_length = options[:static_length]
       end
 
+      def initialize_copy(_orig)
+        @string = @string.dup
+      end
+
       # @param [::String] str
       # @return [String] self
       def read(str)
         s = read_with_length_from(str)
-        s = s[0, static_length] if static_length
-        self.replace(s)
+        register_internal_string s
+        self
+      end
+
+      alias old_sz_to_read sz_to_read
+      private :old_sz_to_read
+
+      # Size to read.
+      # Computed from static_length or length_from, if defined.
+      # @return [Integer]
+      # @since 3.1.6
+      def sz_to_read
+        return static_length if static_length?
+
+        old_sz_to_read
+      end
+
+      # Say if a static length is defined
+      # @return [Boolean]
+      # @since 3.1.6
+      def static_length?
+        !static_length.nil?
+      end
+
+      def format_inspect
+        inspect
+      end
+
+      # Append the given string to String
+      # @param [#to_s] str
+      # @return [self]
+      def <<(str)
+        @string << str.to_s
         self
       end
 
       alias sz length
       alias to_human to_s
       alias from_human read
+
+      private
+
+      def register_internal_string(str)
+        @string = str
+        PacketGen.force_binary(@string)
+      end
     end
   end
 end

data/lib/packetgen/types/tlv.rb

@@ -31,6 +31,8 @@ module PacketGen
     # @deprecated Use {AbstractTLV} instead.
     # @since 3.1.0 deprecated
     class TLV < Fields
+      include Fieldable
+
       # @!attribute type
       #  @return [Integer]
       define_field :type, Int8

data/lib/packetgen/unknown_packet.rb

@@ -0,0 +1,84 @@
+# 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.
+
+module PacketGen
+  # Unknown packet, minimaly mimicking a {Packet}.
+  #
+  # An unknown packet is generated when capturing packets, and a packet cannot
+  # be parsed.
+  # @since 3.2.0
+  class UnknownPacket
+    # List of headers. Always empty
+    # @return [Array]
+    attr_reader :headers
+
+    def initialize
+      @headers = [].freeze
+      @binary_str = PacketGen.force_binary('')
+    end
+
+    # Unknown packet, so unknown protocol.
+    # @return [false]
+    def is?(_protocol)
+      false
+    end
+
+    # Get packet body
+    # @return [Types]
+    def body
+      @binary_str
+    end
+    alias to_s body
+
+    # Set packet body
+    # @param [String] str
+    # @return [void]
+    def body=(str)
+      @binary_str = PacketGen.force_binary(str)
+    end
+
+    # Write packet to a PCapNG file on disk.
+    # @param [String] filename
+    # @return [Array] see return from {PcapNG::File#to_file}
+    # @see File
+    def to_f(filename)
+      PcapNG::File.new.read_array([self]).to_f(filename)
+    end
+    alias write to_f
+
+    # Read binary string
+    # @param [String] binary_string
+    # @return [self]
+    def parse(binary_str, _first_header: nil)
+      @binary_str = PacketGen.force_binary(binary_str)
+      self
+    end
+
+    # @return [String]
+    def inspect
+      # TODO
+    end
+
+    # equality if {#to_s} is equal
+    # @return [Boolean]
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    # True only if +other+ is an {UnknownPacket} and +other == self+
+    # @return [Boolean]
+    def ===(other)
+      case other
+      when UnknwonPacket
+        self == other
+      else
+        false
+      end
+    end
+  end
+end

data/lib/packetgen/utils.rb

@@ -23,7 +23,7 @@ module PacketGen
       raw_cache = `/usr/sbin/arp -an`
 
       cache = {}
-      raw_cache.split(/\n/).each do |line|
+      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+)/)
         cache[match[1]] = [match[2], match[4]] if match
       end
@@ -46,21 +46,20 @@ module PacketGen
     def self.arp(ipaddr, options={})
       unless options[:no_cache]
         local_cache = self.arp_cache
-        return local_cache[ipaddr].first if local_cache.key? ipaddr
+        return local_cache[ipaddr].first if local_cache.key?(ipaddr)
       end
 
       iface = options[:iface] || PacketGen.default_iface
       timeout = options[:timeout] || 1
       my_hwaddr = Config.instance.hwaddr(iface)
       arp_pkt = Packet.gen('Eth', dst: 'ff:ff:ff:ff:ff:ff', src: my_hwaddr)
-      arp_pkt.add('ARP', sha: Config.instance.hwaddr, spa: Config.instance.ipaddr,
-                         tpa: ipaddr)
+                      .add('ARP', sha: Config.instance.hwaddr(iface),
+                                  spa: Config.instance.ipaddr(iface),
+                                  tpa: ipaddr)
 
       capture = Capture.new(iface: iface, timeout: timeout, max: 1,
                             filter: "arp src #{ipaddr} and ether dst #{my_hwaddr}")
-      cap_thread = Thread.new do
-        capture.start
-      end
+      cap_thread = Thread.new { capture.start }
 
       arp_pkt.to_w(iface)
       cap_thread.join

data/lib/packetgen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.2.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-22 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -30,48 +30,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.4
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.4
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: rasn1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -225,6 +225,7 @@ files:
 - lib/packetgen/types/array.rb
 - lib/packetgen/types/cstring.rb
 - lib/packetgen/types/enum.rb
+- lib/packetgen/types/fieldable.rb
 - lib/packetgen/types/fields.rb
 - lib/packetgen/types/int.rb
 - lib/packetgen/types/int_string.rb
@@ -232,16 +233,19 @@ files:
 - lib/packetgen/types/oui.rb
 - lib/packetgen/types/string.rb
 - lib/packetgen/types/tlv.rb
+- lib/packetgen/unknown_packet.rb
 - lib/packetgen/utils.rb
 - lib/packetgen/utils/arp_spoofer.rb
 - lib/packetgen/version.rb
-homepage: https://github.com/sdaubert/packetgen
+homepage: 
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/sdaubert/packetgen
+  source_code_uri: https://github.com/sdaubert/packetgen
   bug_tracker_uri: https://github.com/sdaubert/packetgen/issues
   documentation_uri: https://www.rubydoc.info/gems/packetgen
-  source_code_uri: https://github.com/sdaubert/packetgen
+  wiki_uri: https://github.com/sdaubert/packetgen/wiki
 post_install_message: 
 rdoc_options:
 - "--title"
@@ -256,15 +260,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Network packet generator and dissector