bin_struct 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44d43c8007a5ad33899e5c7ee6a09c306a64a95012bd489ee2d14d69c7e40dcf
-  data.tar.gz: db0b44a68cb8a23b1a5110cb12bb587c4cf4a737b42443f72c0ae9241fffa6c9
+  metadata.gz: aeb290e624ce4004c20cfaf40fc60ae43938c80eab8fd1df1e8aa908a75e26cf
+  data.tar.gz: 8cb5dd0abdce7421b8269a4d35c14886f57cc6440a50c924b0937e5b30fe20ce
 SHA512:
-  metadata.gz: 287f8dbf64a09b27b5fe376f9b6a982055713cdb2453ab7dd2b5ec0489678727441a3545427bb9f1f31d0ccc733bcc10e6af703fdc3b85b7cf539614b306bc21
-  data.tar.gz: cc3ba318afa6ac9706d57676256bbebeeec3b4dc52402728777b8c7a7fb89c9de8d893903b3e753d84a25aa6339b9aa919cfd4a223ff1f1a446a2d169047dee2
+  metadata.gz: ecf6acc2f5c406556598212d22ad6257d22ed646c1128a145cff1730dc537bb7acfd40903f211aad28b11fa30c11324a98b98ecebb70ad7b84ea991bcf181f25
+  data.tar.gz: 1dcfbb20a54f7c08d2794e0e8391b70c633d65f6ccbc41c372e46c77da6fb036fbfa9d1548462030b86603e3e41b132019da70b3c2d603f7f21116bdc842ec14

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.4.0 - 2025-02-13
+
+### Added
+
+- Add `Struct#attribute?` to check existence of an attribute.
+- Add `AbstractTLV.derive` to derive a new subclass from a concrete TLV class.
+
+### Fixed
+
+- Update and fix Yard documentation.
+
 ## 0.3.0 - 2024-12-02
 
 ### Added

data/README.md

@@ -19,6 +19,89 @@ Or add it to a Gemfile:
 gem 'bin_struct'
 ```
 
+## Usage
+
+### Create a struct
+
+To create a BinStruct, create a new class inheriting from `BinStruct::Struct`. Then, defines struct attributes using `.define_attr`. `.define_bit_attr` may also be used to define bit field attributes.
+
+```ruby
+require 'bin_struct'
+
+class IPHeader < BinStruct::Struct
+  # Define a bir field, defaulting to 0x45, and splitted in 2 sub-fields: version and ihl,
+  # 4-bit size each
+  define_bit_attr :u8, default: 0x45, version: 4, ihl: 4
+  # Define a 8-bit unsigned integer named tos
+  #  1st argument: a symbol to define attribute name
+  #  2nd argument: a class to define attribute type. May be a type provided by BinStruct,
+  #                or a user-defined class inheriting from one of these classes
+  #  others arguments: options. Here, :default defines a default value for the attribute.
+  define_attr :tos, BinStruct::Int8, default: 0
+  # Define a 16-bit unsigned integer named length. Default to 20.
+  define_attr :length, BinStruct::Int16, default: 20
+  # Define a 16-bir unsigned integer named id. It is initialized with a random number
+  define_attr :id, BinStruct::Int16, default: ->(_) { rand(65_535) }
+  # Define a bit field composed of 4 subfields of 1, 1, 1 and 13 bit, respectively
+  define_bit_attr :frag, flag_rsv: 1, flag_df: 1, flag_mf: 1, fragment_offset: 13
+  # Define TTL field, a 8-bit unsigned integer, default to 64
+  define_attr :ttl, BinStruct::Int8, default: 64
+  # Define protocol field (8-bit unsigned integer)
+  define_attr :protocol, BinStruct::Int8
+  # Define checksum field (16-bit unsigned integer), default to 0
+  define_attr :checksum, BinStruct::Int16, default: 0
+  # Source and destination addresses, defined as array of 4 8-bit unsigned integers
+  define_attr :src, BinStruct::ArrayOfInt8, length_from: -> { 4 }
+  define_attr :dst, BinStruct::ArrayOfInt8, length_from: -> { 4 }
+end
+```
+
+### Parse a binary string
+
+```ruby
+# Initialize struct from a binary string
+ip = IPHeader.new.read("\x45\x00\x00\x14\x43\x21\x00\x00\x40\x01\x00\x00\x7f\x00\x00\x01\x7f\x00\x00\x01".b)
+
+# Access some fields
+p ip.version     #=> 4
+p ip.ihl         #=> 5
+p ip.id.to_s(16) #=> "4321"
+p ip.protocol    #=> 1
+p ip.src.map { |byte| byte.to_i }.join('.') #=> "127.0.0.1"
+```
+
+```text
+> p IPHeader.new.read("\x45\x00\x00\x14\x43\x21\x00\x00\x40\x01\x00\x00\x7f\x00\x00\x01\x7f\x00\x00\x01")
+-- IPHeader -----------------------------------------------------------
+          BitAttr8               u8: 69               (0x45)
+                                     version:4 ihl:5
+              Int8              tos: 0                (0x00)
+             Int16           length: 20               (0x0014)
+             Int16               id: 17185            (0x4321)
+         BitAttr16             frag: 0                (0x0000)
+                                     flag_rsv:0 flag_df:0 flag_mf:0 fragment_offset:0
+              Int8              ttl: 64               (0x40)
+              Int8         protocol: 1                (0x01)
+             Int16         checksum: 0                (0x0000)
+       ArrayOfInt8              src: 127,0,0,1
+       ArrayOfInt8              dst: 127,0,0,1
+
+```
+
+### Generate a binary string
+
+```ruby
+# Create a new struct with some fields initialized
+ip = IPHeader.new(tos: 42, id: 0x1234)
+
+# Initialize fields after creation
+ip.src = [192, 168, 1, 1]
+ip.dst = [192, 168, 1, 2]
+
+# Generate binary string
+ip.to_s
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/bin_struct/abstract_tlv.rb

@@ -13,7 +13,7 @@ module BinStruct
   #
   # ===Usage
   # To simply define a new TLV class, do:
-  #   MyTLV = PacketGen::Types::AbstractTLV.create
+  #   MyTLV = BinStruct::AbstractTLV.create
   #   MyTLV.define_type_enum 'one' => 1, 'two' => 2
   # This will define a new +MyTLV+ class, subclass of {AbstractTLV}. This class will
   # define 3 attributes:
@@ -32,9 +32,9 @@ module BinStruct
   #
   # ===Advanced usage
   # Each attribute's type may be changed at generating TLV class:
-  #   MyTLV = PacketGen::Types::AbstractTLV.create(type_class: PacketGen::Types::Int16,
-  #                                                length_class: PacketGen::Types::Int16,
-  #                                                value_class: PacketGen::Header::IP::Addr)
+  #   MyTLV = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16,
+  #                                         length_class: BinStruct::Int16,
+  #                                         value_class: PacketGen::Header::IP::Addr)
   #   tlv = MyTLV.new(type: 1, value: '1.2.3.4')
   #   tlv.type        #=> 1
   #   tlv.length      #=> 4
@@ -43,9 +43,9 @@ module BinStruct
   #
   # Some aliases may also be defined. For example, to create a TLV type
   # whose +type+ attribute should be named +code+:
-  #   MyTLV = PacketGen::Types::AbstractTLV.create(type_class: PacketGen::Types::Int16,
-  #                                                length_class: PacketGen::Types::Int16,
-  #                                                aliases: { code: :type })
+  #   MyTLV = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16,
+  #                                         length_class: BinStruct::Int16,
+  #                                         aliases: { code: :type })
   #   tlv = MyTLV.new(code: 1, value: 'abcd')
   #   tlv.code        #=> 1
   #   tlv.type        #=> 1
@@ -77,11 +77,12 @@ module BinStruct
       #   in the desired order.
       # @param [::String] attr_in_length give attributes to compute length on.
       # @return [Class]
+      # @raise [Error] Called on {AbstractTLV} subclass
       def create(type_class: Int8Enum, length_class: Int8, value_class: String,
                  aliases: {}, attr_order: 'TLV', attr_in_length: 'V')
         unless equal?(AbstractTLV)
           raise Error,
-                '.create cannot be called on a subclass of PacketGen::Types::AbstractTLV'
+                '.create cannot be called on a subclass of BinStruct::AbstractTLV'
         end
 
         klass = Class.new(self)
@@ -91,7 +92,7 @@ module BinStruct
         check_attr_in_length(attr_in_length)
         check_attr_order(attr_order)
         generate_attributes(klass, attr_order, type_class, length_class, value_class)
-
+        generate_aliases_for(klass, aliases)
         aliases.each do |al, orig|
           klass.instance_eval do
             alias_method al, orig if klass.method_defined?(orig)
@@ -103,6 +104,50 @@ module BinStruct
       end
       # rubocop:enable Metrics/ParameterLists
 
+      # On inheritage, copy aliases and attr_in_length
+      # @param [Class] klass inheriting class
+      # @return [void]
+      # @since 0.4.0
+      # @author LemonTree55
+      def inherited(klass)
+        super
+
+        aliases = @aliases.clone
+        attr_in_length = @attr_in_length.clone
+
+        klass.class_eval do
+          @aliases = aliases
+          @attr_in_length = attr_in_length
+        end
+      end
+
+      # Derive a new TLV class from an existing one
+      # @param [Class,nil] type_class New class to use for +type+. Unchanged if +nil+.
+      # @param [Class,nil] length_class New class to use for +length+. Unchanged if +nil+.
+      # @param [Class,nil] value_class New class to use for +value+. Unchanged if +nil+.
+      # @return [Class]
+      # @raise [Error] Called on {AbstractTLV} class
+      # @since 0.4.0
+      # @author LemonTree55
+      # @example
+      #   # TLV with type and length on 16 bits, value is a BinStruct::String
+      #   FirstTLV = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16, length_class: BinStruct::Int16)
+      #   # TLV with same type and length classes than FirstTLV, but value is an array of Int8
+      #   SecondTLV = FirstTLV.derive(value_class: BinStruct::ArrayOfInt8)
+      def derive(type_class: nil, length_class: nil, value_class: nil, aliases: {})
+        raise Error, ".derive cannot be called on #{name}" if equal?(AbstractTLV)
+
+        klass = Class.new(self)
+        klass.aliases.merge!(aliases)
+        generate_aliases_for(klass, aliases)
+
+        klass.attr_defs[:type].type = type_class unless type_class.nil?
+        klass.attr_defs[:length].type = length_class unless length_class.nil?
+        klass.attr_defs[:value].type = value_class unless value_class.nil?
+
+        klass
+      end
+
       # @!attribute type
       #   @abstract
       #   Type attribute for real TLV class
@@ -168,6 +213,15 @@ module BinStruct
           end
         end
       end
+
+      def generate_aliases_for(klass, aliases)
+        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
+      end
     end
 
     # @!attribute type

data/lib/bin_struct/array.rb

@@ -9,7 +9,7 @@
 require 'forwardable'
 
 module BinStruct
-  # @abstract Base class to define set of {Struct} subclasses.
+  # @abstract Base class to define set of {Structable} subclasses.
   #
   # This class mimics regular Ruby Array, but it is {Structable} and responds to {LengthFrom}.
   #
@@ -44,10 +44,11 @@ module BinStruct
     # @!method clear
     #   Clear array.
     #   @return [void]
+    #   @see #clear!
     # @!method each
     #   Calls the given block once for each element in self, passing that
-    #   element as a parameter. Returns the array itself.
-    #   @return [::Array]
+    #   element as a parameter. Returns the array itself, or an enumerator if no block is given.
+    #   @return [::Array, Enumerator]
     # @method empty?
     #   Return +true+ if contains no element.
     #   @return [Boolean]
@@ -112,6 +113,7 @@ module BinStruct
 
     # Clear array. Reset associated counter, if any.
     # @return [void]
+    # @see #clear
     def clear!
       @array.clear
       @counter&.from_human(0)
@@ -137,7 +139,8 @@ module BinStruct
 
     # @abstract depend on private method +#record_from_hash+ which should be
     #   declared by subclasses.
-    # Add an object to this array. Do not update associated counter.
+    # Add an object to this array. Do not update associated counter. If associated must be incremented, use
+    # {#<<}
     # @param [Object] obj type depends on subclass
     # @return [self]
     # @see #<<
@@ -154,9 +157,11 @@ module BinStruct
 
     # @abstract depend on private method +#record_from_hash+ which should be
     #   declared by subclasses.
-    # Add an object to this array, and increment associated counter, if any
+    # Add an object to this array, and increment associated counter, if any. If associated counter must not be
+    # incremented, use {#push}.
     # @param [Object] obj type depends on subclass
     # @return [self]
+    # @see #push
     def <<(obj)
       push(obj)
       @counter&.from_human(@counter.to_i + 1)

data/lib/bin_struct/bit_attr.rb

@@ -15,13 +15,14 @@ module BinStruct
   #    define_attr :int32, BinStruct::BitAttr.create(width: 32, a: 16, b: 4, c: 4, d:8)
   #  end
   # @since 0.3.0
+  # @abstract Subclasses must de derived using {.create}.
   # @author LemonTree55
   class BitAttr
     include Structable
 
     # @return [Integer] width in bits of bit attribute
     attr_reader :width
-    # @return [Array[Symbol]]
+    # @return [::Array[Symbol]]
     attr_reader :bit_methods
 
     # @private
@@ -79,9 +80,10 @@ module BinStruct
     # @param [Hash{Symbol=>Integer}] opts initialization values for fields, where keys are field names and values are
     #     initialization values
     # @return [self]
+    # @raise [NotImplementedError] raised when called on {BitAttr} class
     def initialize(opts = {})
       parameters = self.class.parameters
-      raise NotImplementedError, '#initialize may only be called on subclass of {self.class}' if parameters.nil?
+      raise NotImplementedError, "#initialize may only be called on subclass of #{self.class}" if parameters.nil?
 
       @width = parameters.width
       @fields = parameters.fields
@@ -110,7 +112,7 @@ module BinStruct
     end
 
     # Populate bit attribute from +str+
-    # @param [::String,nil] str
+    # @param [#to_s,nil] str
     # @return [self]
     def read(str)
       return self if str.nil?
@@ -175,7 +177,7 @@ module BinStruct
       if size == 1
         instance_eval "def #{name}?; @data[#{name.inspect}] != 0; end\n", __FILE__, __LINE__
         instance_eval "def #{name}=(val); v = case val when TrueClass; 1 when FalseClass; 0 else val end; " \
-                      "@data[#{name.inspect}] = v; end", __FILE__, __LINE__ - 2
+                      "@data[#{name.inspect}] = v; end", __FILE__, __LINE__ - 1
         bit_methods << :"#{name}?"
       else
         instance_eval "def #{name}=(val); @data[#{name.inspect}] = val; end", __FILE__, __LINE__

data/lib/bin_struct/cstring.rb

@@ -76,14 +76,14 @@ module BinStruct
 
     # @param [Hash] options
     # @option options [Integer] :static_length set a static length for this string
-    # @option options [::String] :value string value (default to +''+)
+    # @option options [::String] :value string value (default to +""+)
     def initialize(options = {})
       register_internal_string(options[:value] || +'')
       @static_length = options[:static_length]
     end
 
     # Populate self from binary string
-    # @param [::String] str
+    # @param [#to_s] str
     # @return [self]
     def read(str)
       s = str.to_s

data/lib/bin_struct/enum.rb

@@ -13,19 +13,20 @@ module BinStruct
   # and named values.
   #
   # == Simple example
-  #  enum = Int8Enum.new('low' => 0, 'medium' => 1, 'high' => 2})
+  #   enum = Int8Enum.new('low' => 0, 'medium' => 1, 'high' => 2})
   # In this example, +enum+ is a 8-bit attribute which may take one
   # among three values: +low+, +medium+ or +high+:
-  #  enum.value = 'high'
-  #  enum.value              # => 2
-  #  enum.value = 1
-  #  enum.value              # => 1
-  #  enum.to_human           # => "medium"
-  # Setting an unknown value will raise an exception:
-  #  enum.value = 4          # => raise!
-  #  enum.value = 'unknown'  # => raise!
-  # But {#read} will not raise when reading an outbound value. This
+  #   enum.value = 'high'
+  #   enum.value              # => 2
+  #   enum.value = 1
+  #   enum.value              # => 1
+  #   enum.to_human           # => "medium"
+  # Setting an unknown name will raise an exception:
+  #   enum.value = 'unknown'  # => raise!
+  # But {#read} and {#value=} will not raise when reading/setting an out-of-bound integer. This
   # to enable decoding (or forging) of bad packets.
+  #   enum.read("\x05".b).value # => 5
+  #   enum.value = 4            # => 4
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
   class Enum < Int

data/lib/bin_struct/int.rb

@@ -55,7 +55,7 @@ module BinStruct
 
     # @abstract
     # @return [::String]
-    # @raise [Error] This is an abstrat method and must be redefined
+    # @raise [Error] This is an abstract method and must be redefined
     def to_s
       raise Error, 'BinStruct::Int#to_s is abstract' unless defined? @packstr
 

data/lib/bin_struct/int_string.rb

@@ -9,6 +9,13 @@
 module BinStruct
   # Provides a class for creating strings preceeded by their length as an {Int}.
   # By default, a null string will have one byte length (length byte set to 0).
+  # == Examples
+  #   # IntString with 8-bit length
+  #   is8 = BinStruct::IntString.new(value: "abcd")
+  #   is8.to_s   # => "\x04abcd"
+  #   # IntString with 16-bit length
+  #   is16 = BinStruct::IntString.new(length_type: BinStruct::Int16le, value: "abcd")
+  #   is16.to_s  # => "\x04\x00abcd"
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
   class IntString

data/lib/bin_struct/string.rb

@@ -32,7 +32,7 @@ module BinStruct
     # @option options [Int,Proc] :length_from object or proc from which
     #   takes length when reading
     # @option options [Integer] :static_length set a static length for this string
-    # @option options [::String] :value string value (default to +''+)
+    # @option options [::String] :value string value (default to +""+)
     def initialize(options = {})
       register_internal_string(options[:value] || +'')
       initialize_length_from(options)
@@ -47,7 +47,7 @@ module BinStruct
     end
 
     # Populate String from a binary String. Limit length using {LengthFrom} or {#static_length}, if one is set.
-    # @param [::String] str
+    # @param [::String,nil] str
     # @return [self]
     def read(str)
       s = read_with_length_from(str)
@@ -87,7 +87,7 @@ module BinStruct
       self
     end
 
-    # Generate binary string
+    # Generate "binary" string
     # @return [::String]
     def to_s
       @string

data/lib/bin_struct/struct.rb

@@ -401,6 +401,15 @@ module BinStruct
       @attributes[attr] = obj
     end
 
+    # Say if struct has given attribute
+    # @param [Symbol] attr attribute name
+    # @return [Boolean]
+    # @since 0.4.0
+    # @author LemonTree55
+    def attribute?(attr)
+      @attributes.key?(attr)
+    end
+
     # Get all attribute names
     # @return [Array<Symbol>]
     def attributes
@@ -575,7 +584,7 @@ module BinStruct
     # @return [String]
     def inspect_titleize
       title = self.class.to_s
-      +"-- #{title} #{'-' * (66 - title.length)}\n"
+      "-- #{title} #{'-' * (66 - title.length)}\n"
     end
 
     # @param [:Symbol] attr

data/lib/bin_struct/version.rb

@@ -8,5 +8,5 @@
 
 module BinStruct
   # BinStruct version
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bin_struct
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - LemonTree55
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies: []
 description: 'BinStruct is a binary dissector and generator. It eases manipulating
   complex binary data.
@@ -58,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="