packetgen 3.3.0 → 3.3.2

data/lib/packetgen/types/abstract_tlv.rb

@@ -2,8 +2,9 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/sdaubert/packetgen for more informations
+# See https://github.com/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 module PacketGen
@@ -60,65 +61,125 @@ 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
-        end
-        klass.define_field :length, length_class
-        klass.define_field :value, value_class
+        # @private
+        attr_accessor :field_in_length
+
+        # rubocop:disable Metrics/ParameterLists
 
-        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}=")
+        # 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
+        # rubocop:enable Metrics/ParameterLists
+
+        # @!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{String, Symbol => Integer}] hsh enum hash
+        # @return [void]
+        def define_type_enum(hsh)
+          field_defs[:type][:enum].clear
+          field_defs[:type][:enum].merge!(hsh)
+        end
+
+        # @abstract Should only be called on real TLV classes, created by {.create}.
+        # Set default value for {#type} field.
+        # @param [Integer,String,Symbol,nil] default default value from +hsh+ for type
+        # @return [void]
+        # @since 3.4.0
+        def define_type_default(default)
+          field_defs[:type][:default] = default
+        end
+
+        private
+
+        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
 
-        klass
+        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
+
       # @!attribute type
-      #   @abstract Type attribute for real TLV class
+      #   @abstract Type attribute
       #   @return [Integer]
       # @!attribute length
-      #   @abstract Length attribute for real TLV class
+      #   @abstract Length
       #   @return [Integer]
       # @!attribute value
-      #   @abstract Value attribute for real TLV class
+      #   @abstract Value attribute
       #   @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 self.define_type_enum(hsh)
-        field_defs[:type][:enum].clear
-        field_defs[:type][:enum].merge!(hsh)
-      end
-
       # @abstract Should only be called on real TLV classes, created by {.create}.
       # @param [Hash] options
       # @option options [Integer] :type
@@ -126,6 +187,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
@@ -133,30 +195,41 @@ module PacketGen
         super
         # used #value= defined below, which set length if needed
         self.value = options[:value] if options[:value]
+        calc_length unless options.key?(:length)
       end
 
       # @abstract Should only be called on real TLV class instances.
       # Populate object from a binary string
-      # @param [String] str
+      # @param [String,nil] str
       # @return [Fields] self
       def read(str)
+        return self if str.nil?
+
         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
 
       # @abstract Should only be called on real TLV class instances.
       # Set +value+. May set +length+ if value is a {Types::String}.
-      # @param [::String,Integer] val
-      # @return [::String,Integer]
+      # @param [Object] val
+      # @return [Object]
+      # @since 3.4.0 Base on field's +#from_human+ method
       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
+        if val.is_a?(self[:value].class)
+          self[:value] = val
+        elsif self[:value].respond_to?(:from_human)
+          self[:value].from_human(val)
+        else
+          self[:value].read(val)
+        end
+        calc_length
         val
       end
 
@@ -174,13 +247,30 @@ module PacketGen
         'type:%s,length:%u,value:%s' % [human_type, length, my_value]
       end
 
+      # Calculate length
+      # @return [void]
+      # @since 3.4.0
+      def calc_length
+        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
+      end
+
       private
 
       def real_length
         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/array.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/sdaubert/packetgen for more informations
+# See https://github.com/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 require 'forwardable'
@@ -225,8 +226,8 @@ module PacketGen
         klass == obj_klass ? obj : klass.new(hsh)
       end
 
-      def real_type(obj)
-        obj.class
+      def real_type(_obj)
+        self.class.set_of_klass
       end
 
       def create_object_from_str(str)
@@ -242,28 +243,44 @@ module PacketGen
       end
     end
 
+    # @private
+    module ArrayOfIntMixin
+      def read_from_array(ary)
+        return self if ary.empty?
+
+        ary.each do |i|
+          self << self.class.set_of_klass.new(i)
+        end
+      end
+    end
+
     # Specialized array to handle serie of {Int8}.
     class ArrayOfInt8 < Array
+      include ArrayOfIntMixin
       set_of Int8
     end
 
     # Specialized array to handle serie of {Int16}.
     class ArrayOfInt16 < Array
+      include ArrayOfIntMixin
       set_of Int16
     end
 
     # Specialized array to handle serie of {Int16le}.
     class ArrayOfInt16le < Array
+      include ArrayOfIntMixin
       set_of Int16le
     end
 
     # Specialized array to handle serie of {Int32}.
     class ArrayOfInt32 < Types::Array
+      include ArrayOfIntMixin
       set_of Types::Int32
     end
 
     # Specialized array to handle serie of {Int32le}.
     class ArrayOfInt32le < Types::Array
+      include ArrayOfIntMixin
       set_of Types::Int32le
     end
   end

data/lib/packetgen/types/cstring.rb

@@ -2,8 +2,9 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/sdaubert/packetgen for more informations
+# See https://github.com/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 require 'forwardable'

data/lib/packetgen/types/enum.rb

@@ -2,8 +2,9 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/sdaubert/packetgen for more informations
+# See https://github.com/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 module PacketGen
@@ -14,7 +15,7 @@ module PacketGen
     # and named values.
     #
     # == Simple example
-    #  enum = Int8Enum.new(0, 'low' => 0, 'medium' => 1, 'high' => 2})
+    #  enum = Int8Enum.new('low' => 0, 'medium' => 1, 'high' => 2})
     # In this example, +enum+ is a 8-bit field which may take one
     # among three values: +low+, +medium+ or +high+:
     #  enum.value = 'high'

data/lib/packetgen/types/fieldable.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/sdaubert/packetgen for more informations
+# See https://github.com/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 module PacketGen
@@ -55,7 +56,7 @@ module PacketGen
 
       # rubocop:enable Lint/UselessMethodDefinition
 
-      # Format object when inspecting a {Field} object
+      # Format object when inspecting a {Fields} object
       # @return [String]
       def format_inspect
         to_human

data/lib/packetgen/types/fields.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/sdaubert/packetgen for more informations
+# See https://github.com/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 # rubocop:disable Metrics/ClassLength
@@ -236,7 +237,7 @@ module PacketGen
           fields.delete name
           @field_defs.delete name
           undef_method name if method_defined?(name)
-          undef_method "#{name}=" if method_defined?("#{name}=")
+          undef_method :"#{name}=" if method_defined?(:"#{name}=")
         end
 
         # Update a previously defined field
@@ -309,7 +310,7 @@ module PacketGen
           return if fields.nil?
 
           fields.each do |field, size|
-            undef_method "#{field}="
+            undef_method :"#{field}="
             undef_method(size == 1 ? "#{field}?" : field)
           end
         end
@@ -332,7 +333,7 @@ module PacketGen
             # rubocop:enable Layout/LineContinuationLeadingSpace
           end
 
-          define.delete_at(1) if instance_methods.include? "#{name}=".to_sym
+          define.delete_at(1) if instance_methods.include?(:"#{name}=")
           define.delete_at(0) if instance_methods.include? name
           class_eval define.join("\n")
         end
@@ -393,7 +394,7 @@ module PacketGen
         end
 
         def field_defs_property_from(field, property, options)
-          field_defs[field].send("#{property}=", options.delete(property)) if options.key?(property)
+          field_defs[field].send(:"#{property}=", options.delete(property)) if options.key?(property)
         end
 
         def size_from(args)
@@ -422,9 +423,9 @@ module PacketGen
           initialize_optional field
         end
 
-        self.class.bit_fields.each do |_, hsh|
+        self.class.bit_fields.each_value do |hsh|
           hsh.each_key do |bit_field|
-            self.send "#{bit_field}=", options[bit_field] if options[bit_field]
+            self.send(:"#{bit_field}=", options[bit_field]) if options[bit_field]
           end
         end
       end

data/lib/packetgen/types/int.rb

@@ -2,8 +2,9 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/sdaubert/packetgen for more informations
+# See https://github.com/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
 module PacketGen
@@ -11,6 +12,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 +20,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 +131,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 +156,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 +177,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 +201,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 +283,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 +325,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 +346,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 +370,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 +412,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 +456,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