packetgen 3.1.1 → 3.1.6

data/lib/packetgen/types/int.rb

@@ -1,17 +1,19 @@
 # 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
   module Types
     # Base integer class to handle binary integers
     # @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
@@ -56,9 +58,7 @@ module PacketGen
       # @return [::String]
       # @raise [ParseError] This is an abstrat method and must be redefined
       def to_s
-        unless defined? @packstr
-          raise ParseError, 'PacketGen::Types::Int#to_s is an abstract method'
-        end
+        raise ParseError, 'PacketGen::Types::Int#to_s is an abstract method' unless defined? @packstr
 
         [to_i].pack(@packstr[@endian])
       end
@@ -82,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

@@ -1,17 +1,19 @@
 # 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
   module Types
     # Provides a class for creating strings preceeded by their length as a {Int}.
     # 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

@@ -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
   module Types
     # This module is a mixin adding +length_from+ capacity to a type.
@@ -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 < 0
-        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

@@ -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
   module Types
     # OUI type, defined as a set of 3 bytes
@@ -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

@@ -1,20 +1,28 @@
 # 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 '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?
+
+      # @return [::String]
+      attr_reader :string
       # @return [Integer]
       attr_reader :static_length
 
@@ -23,7 +31,7 @@ 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
@@ -32,14 +40,44 @@ module PacketGen
       # @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
+
       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

@@ -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
   module Types
     # Class to handle Type-Length-Value attributes
@@ -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/utils.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_relative 'config'
 require_relative 'utils/arp_spoofer'
 
@@ -53,8 +53,8 @@ module PacketGen
       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}")

data/lib/packetgen/utils/arp_spoofer.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 Utils
     # @note This class is provided for test purpose.

data/lib/packetgen/version.rb

@@ -1,14 +1,14 @@
+# 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
-
 # PacketGen is a network packet generator and analyzor.
 #
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '3.1.1'
+  VERSION = '3.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.6
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -30,62 +30,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.4
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.4
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: rasn1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
+        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
@@ -100,20 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -128,21 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description: |
+  PacketGen is a network packet manipulation library. It allows reading, parsing
+  and sending network packets with fun.
 email:
 - sylvain.daubert@laposte.net
 executables:
 - pgconsole
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - bin/pgconsole
 - lib/packetgen.rb
 - lib/packetgen/capture.rb
@@ -235,8 +206,10 @@ files:
 - lib/packetgen/header/tftp.rb
 - lib/packetgen/header/udp.rb
 - lib/packetgen/headerable.rb
+- lib/packetgen/inject.rb
 - lib/packetgen/inspect.rb
 - lib/packetgen/packet.rb
+- lib/packetgen/pcap.rb
 - lib/packetgen/pcapng.rb
 - lib/packetgen/pcapng/block.rb
 - lib/packetgen/pcapng/epb.rb
@@ -245,12 +218,14 @@ files:
 - lib/packetgen/pcapng/shb.rb
 - lib/packetgen/pcapng/spb.rb
 - lib/packetgen/pcapng/unknown_block.rb
+- lib/packetgen/pcaprub_wrapper.rb
 - lib/packetgen/proto.rb
 - lib/packetgen/types.rb
 - lib/packetgen/types/abstract_tlv.rb
 - 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
@@ -261,13 +236,23 @@ files:
 - lib/packetgen/utils.rb
 - lib/packetgen/utils/arp_spoofer.rb
 - lib/packetgen/version.rb
-- packetgen.gemspec
-homepage: https://github.com/sdaubert/packetgen
+homepage: 
 licenses:
 - MIT
-metadata: {}
+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
+  wiki_uri: https://github.com/sdaubert/packetgen/wiki
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--title"
+- PacketGen - network packet dissector
+- "--main"
+- README.md
+- "--inline-source"
+- "--quiet"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -282,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Network packet generator and dissector