packetgen 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de85a6f18ac001823cdbd0802c8946ead811be724c9069266b78c493d99feb6b
-  data.tar.gz: ef73ca367e87bb47ca4f37ee387c7a73d0ad0f19cebaca151443560f42508559
+  metadata.gz: cdbaefa45999efbdef944fd579a9657a4ce4cfbf247bab09a4a7692ac22f9126
+  data.tar.gz: 8bce62a68be0b6803eea0a1323009c0413c20e1b4628062f22bcb240909f93a5
 SHA512:
-  metadata.gz: '01605812af7b7d53111bfdc0d4d095cb6f0df4975634db17700d7c15c6acc63ba82585e6c5a5d2d93c130d566f45bb62d9ff3709c27e0f7cf4ea0c20ba7c172f'
-  data.tar.gz: e4a54c74e032ee12d744f94c657416591c0f056a005da4b104c017294d73819596a28ec59c71597f8d0f2398da79a8b7784809d5e30cd5da9d53fc655101e2f4
+  metadata.gz: 20246ef1684a643dc0f18ecb25558e78ae70197f141dfa059bbd5559806c87229436432816a7ca3c1008910f15c010842a08dca0de5e50499fad283566953f01
+  data.tar.gz: c8576c49901a2c49336b638f859d80446c0773701177e3aeb4d24324c264d00f58ec4fbe6a3c5a1dd71247385f0fcb421953e4b1865144119a9d07242c0d6f97

data/lib/packetgen/types/abstract_tlv.rb

@@ -60,63 +60,101 @@ module PacketGen
     class AbstractTLV < Types::Fields
       include Fieldable
 
+      # @private
+      FIELD_TYPES = { 'T' => :type, 'L' => :length, 'V' => :value }.freeze
+
       class << self
         # @return [Hash]
         attr_accessor :aliases
+        # @deprecated
         attr_accessor :header_in_length
-      end
-      self.aliases = {}
-
-      # Generate a TLV class
-      # @param [Class] type_class Class to use for +type+
-      # @param [Class] length_class Class to use for +length+
-      # @param [Class] value_class Class to use for +value+
-      # @param [Boolean] header_in_length if +true +, +type+ and +length+ fields are
-      #   included in length
-      # @return [Class]
-      # @since 3.1.4 Add +header_in_length+ parameter
-      def self.create(type_class: Int8Enum, length_class: Int8, value_class: String,
-                      aliases: {}, header_in_length: false)
-        raise Error, '.create cannot be called on a subclass of PacketGen::Types::AbstractTLV' unless self.equal? AbstractTLV
-
-        klass = Class.new(self)
-        klass.aliases = aliases
-        klass.header_in_length = header_in_length
-
-        if type_class < Enum
-          klass.define_field :type, type_class, enum: {}
-        else
-          klass.define_field :type, type_class
+        # @private
+        attr_accessor :field_in_length
+
+        # Generate a TLV class
+        # @param [Class] type_class Class to use for +type+
+        # @param [Class] length_class Class to use for +length+
+        # @param [Class] value_class Class to use for +value+
+        # @param [Boolean] header_in_length if +true +, +type+ and +length+ fields are
+        #   included in length. Deprecated, use +field_in_length+ instead.
+        # @param [String] field_order give field order. Each character in [T,L,V] MUST be present once, in the desired order.
+        # @param [String] field_in_length give fields to compute length on.
+        # @return [Class]
+        # @since 3.1.4 Add +header_in_length+ parameter
+        # @since 3.3.1 Add +field_order+ and +field_in_length' parameters. Deprecate +header_in_length+ parameter.
+        def create(type_class: Int8Enum, length_class: Int8, value_class: String,
+                   aliases: {}, header_in_length: false, field_order: 'TLV', field_in_length: 'V')
+          Deprecation.deprecated_option(self, 'create', 'header_in_length', klass_method: true) if header_in_length
+          raise Error, '.create cannot be called on a subclass of PacketGen::Types::AbstractTLV' unless self.equal?(AbstractTLV)
+
+          klass = Class.new(self)
+          klass.aliases = aliases
+          klass.header_in_length = header_in_length
+          klass.field_in_length = field_in_length
+
+          check_field_in_length(field_in_length)
+          check_field_order(field_order)
+          generate_fields(klass, field_order, type_class, length_class, value_class)
+
+          aliases.each do |al, orig|
+            klass.instance_eval do
+              alias_method al, orig if klass.method_defined?(orig)
+              alias_method :"#{al}=", :"#{orig}=" if klass.method_defined?(:"#{orig}=")
+            end
+          end
+
+          klass
         end
-        klass.define_field :length, length_class
-        klass.define_field :value, value_class
 
-        aliases.each do |al, orig|
-          klass.instance_eval do
-            alias_method al, orig if klass.method_defined?(orig)
-            alias_method :"#{al}=", :"#{orig}=" if klass.method_defined?(:"#{orig}=")
-          end
+        # @!attribute type
+        #   @abstract Type attribute for real TLV class
+        #   @return [Integer]
+        # @!attribute length
+        #   @abstract Length attribute for real TLV class
+        #   @return [Integer]
+        # @!attribute value
+        #   @abstract Value attribute for real TLV class
+        #   @return [Object]
+
+        # @abstract Should only be called on real TLV classes, created by {.create}.
+        # Set enum hash for {#type} field.
+        # @param [Hash] hsh enum hash
+        # @return [void]
+        def define_type_enum(hsh)
+          field_defs[:type][:enum].clear
+          field_defs[:type][:enum].merge!(hsh)
         end
 
-        klass
-      end
-      # @!attribute type
-      #   @abstract Type attribute for real TLV class
-      #   @return [Integer]
-      # @!attribute length
-      #   @abstract Length attribute for real TLV class
-      #   @return [Integer]
-      # @!attribute value
-      #   @abstract Value attribute for real TLV class
-      #   @return [Object]
+        private
 
-      # @abstract Should only be called on real TLV classes, created by {.create}.
-      # Set enum hash for {#type} field.
-      # @param [Hash] hsh enum hash
-      # @return [void]
-      def self.define_type_enum(hsh)
-        field_defs[:type][:enum].clear
-        field_defs[:type][:enum].merge!(hsh)
+        def check_field_in_length(field_in_length)
+          return if /^[TLV]{1,3}$/.match?(field_in_length)
+
+          raise 'field_in_length must only contain T, L and/or V characters'
+        end
+
+        def check_field_order(field_order)
+          return if field_order.match(/^[TLV]{3,3}$/) && (field_order[0] != field_order[1]) && (field_order[0] != field_order[2]) && (field_order[1] != field_order[2])
+
+          raise 'field_order must contain all three letters TLV, each once'
+        end
+
+        def generate_fields(klass, field_order, type_class, length_class, value_class)
+          field_order.each_char do |field_type|
+            case field_type
+            when 'T'
+              if type_class < Enum
+                klass.define_field(:type, type_class, enum: {})
+              else
+                klass.define_field(:type, type_class)
+              end
+            when 'L'
+              klass.define_field(:length, length_class)
+            when 'V'
+              klass.define_field(:value, value_class)
+            end
+          end
+        end
       end
 
       # @abstract Should only be called on real TLV classes, created by {.create}.
@@ -126,6 +164,7 @@ module PacketGen
       # @option options [Object] :value
       def initialize(options={})
         @header_in_length = self.class.header_in_length
+        @field_in_length = self.class.field_in_length
         self.class.aliases.each do |al, orig|
           options[orig] = options[al] if options.key?(al)
         end
@@ -141,11 +180,13 @@ module PacketGen
       # @return [Fields] self
       def read(str)
         idx = 0
-        self[:type].read str[idx, self[:type].sz]
-        idx += self[:type].sz
-        self[:length].read str[idx, self[:length].sz]
-        idx += self[:length].sz
-        self[:value].read str[idx, real_length]
+        fields.each do |field_name|
+          field = self[field_name]
+          length = field_name == :value ? real_length : field.sz
+          field.read(str[idx, length])
+          idx += field.sz
+        end
+
         self
       end
 
@@ -154,9 +195,17 @@ module PacketGen
       # @param [::String,Integer] val
       # @return [::String,Integer]
       def value=(val)
-        self[:value].from_human val
-        self.length = self[:value].sz
-        self.length += self[:type].sz + self[:length].sz if @header_in_length
+        self[:value].from_human(val)
+
+        fil = @field_in_length
+        fil = 'TLV' if @header_in_length
+
+        length = 0
+        fil.each_char do |field_type|
+          length += self[FIELD_TYPES[field_type]].sz
+        end
+        self.length = length
+
         val
       end
 
@@ -180,7 +229,10 @@ module PacketGen
         if @header_in_length
           self.length - self[:type].sz - self[:length].sz
         else
-          self.length
+          length = self.length
+          length -= self[:type].sz if @field_in_length.include?('T')
+          length -= self[:length].sz if @field_in_length.include?('L')
+          length
         end
       end
     end

data/lib/packetgen/types/int.rb

@@ -11,6 +11,7 @@ module PacketGen
     # Base integer class to handle binary integers
     # @abstract
     # @author Sylvain Daubert
+    # @since 3.3.1 support native endianess
     class Int
       include Fieldable
 
@@ -18,7 +19,8 @@ module PacketGen
       # @return [Integer]
       attr_accessor :value
       # Integer endianness
-      # @return [:little,:big]
+      # @return [:little,:big,:native]
+      # @since 3.3.1 add :native
       attr_accessor :endian
       # Integer size, in bytes
       # @return [Integer]
@@ -128,10 +130,10 @@ module PacketGen
     # @author Sylvain Daubert
     class Int16 < Int
       # @param [Integer,nil] value
-      # @param [:big, :little] endian
+      # @param [:big, :little, :native] endian
       def initialize(value=nil, endian=:big)
         super(value, endian, 2)
-        @packstr = { big: 'n', little: 'v' }
+        @packstr = { big: 'n', little: 'v', native: 'S' }
       end
     end
 
@@ -153,6 +155,19 @@ module PacketGen
       end
     end
 
+    # native endian 2-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 3.3.1
+    class Int16n < Int16
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :native)
+      end
+    end
+
     # 2-byte signed integer
     # @author Sylvain Daubert
     # @since 2.8.2
@@ -161,7 +176,7 @@ module PacketGen
       # @param [:big, :little] endian
       def initialize(value=nil, endian=:big)
         super
-        @packstr = { big: 's>', little: 's<' }
+        @packstr = { big: 's>', little: 's<', native: 's' }
       end
     end
 
@@ -185,13 +200,33 @@ module PacketGen
       end
     end
 
+    # native endian 2-byte signed integer
+    # @author Sylvain Daubert
+    # @since 3.3.1
+    class SInt16n < SInt16
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :native)
+      end
+    end
+
     # 3-byte unsigned integer
     # @author Sylvain Daubert
     # @since 2.1.4
     class Int24 < Int
       # @param [Integer,nil] value
-      # @param [:big, :little] endian
+      # @param [:big, :little, :native] endian
       def initialize(value=nil, endian=:big)
+        if endian == :native
+          endian = if [1].pack('S').unpack1('n') == 1
+                     :big
+                   else
+                     :little
+                   end
+        end
         super(value, endian, 3)
       end
 
@@ -247,14 +282,27 @@ module PacketGen
       end
     end
 
+    # native endian 3-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 3.3.1
+    class Int24n < Int24
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :native)
+      end
+    end
+
     # 4-byte unsigned integer
     # @author Sylvain Daubert
     class Int32 < Int
       # @param [Integer,nil] value
-      # @param [:big, :little] endian
+      # @param [:big, :little, :native] endian
       def initialize(value=nil, endian=:big)
         super(value, endian, 4)
-        @packstr = { big: 'N', little: 'V' }
+        @packstr = { big: 'N', little: 'V', native: 'L' }
       end
     end
 
@@ -276,6 +324,19 @@ module PacketGen
       end
     end
 
+    # native endian 4-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 3.3.1
+    class Int32n < Int32
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :native)
+      end
+    end
+
     # 4-byte unsigned integer
     # @author Sylvain Daubert
     # @since 2.8.2
@@ -284,7 +345,7 @@ module PacketGen
       # @param [:big, :little] endian
       def initialize(value=nil, endian=:big)
         super
-        @packstr = { big: 'l>', little: 'l<' }
+        @packstr = { big: 'l>', little: 'l<', native: 'l' }
       end
     end
 
@@ -308,14 +369,27 @@ module PacketGen
       end
     end
 
+    # native endian 4-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 3.3.1
+    class SInt32n < SInt32
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :native)
+      end
+    end
+
     # 8-byte unsigned integer
     # @author Sylvain Daubert
     class Int64 < Int
       # @param [Integer,nil] value
-      # @param [:big, :little] endian
+      # @param [:big, :little, :native] endian
       def initialize(value=nil, endian=:big)
         super(value, endian, 8)
-        @packstr = { big: 'Q>', little: 'Q<' }
+        @packstr = { big: 'Q>', little: 'Q<', native: 'Q' }
       end
     end
 
@@ -337,15 +411,28 @@ module PacketGen
       end
     end
 
+    # native endian 8-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 3.3.1
+    class Int64n < Int64
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :native)
+      end
+    end
+
     # 8-byte unsigned integer
     # @author Sylvain Daubert
     # @since 2.8.2
     class SInt64 < Int64
       # @param [Integer,nil] value
-      # @param [:big, :little] endian
+      # @param [:big, :little, :native] endian
       def initialize(value=nil, endian=:big)
         super
-        @packstr = { big: 'q>', little: 'q<' }
+        @packstr = { big: 'q>', little: 'q<', native: 'q' }
       end
     end
 
@@ -368,5 +455,18 @@ module PacketGen
         super(value, :little)
       end
     end
+
+    # native endian 8-byte unsigned integer
+    # @author Sylvain Daubert
+    # @since 3.3.1
+    class SInt64n < SInt64
+      # @param [Integer,nil] value
+      undef endian=
+
+      # @param [Integer, nil] value
+      def initialize(value=nil)
+        super(value, :native)
+      end
+    end
   end
 end

data/lib/packetgen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Sylvain Daubert
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -189,7 +189,7 @@ files:
 - lib/packetgen/utils.rb
 - lib/packetgen/utils/arp_spoofer.rb
 - lib/packetgen/version.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
@@ -198,7 +198,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options:
 - "--title"
 - PacketGen - network packet dissector
@@ -219,8 +219,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Network packet generator and dissector
 test_files: []