ronin-support 0.5.2 → 1.0.0.beta1

data/lib/ronin/binary/struct.rb

@@ -1,567 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
-#
-# ronin-support is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# ronin-support is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/binary/template'
-
-require 'set'
-
-module Ronin
-  module Binary
-    #
-    # Generic Binary Struct class.
-    #
-    # ## Example
-    #
-    #     class Packet < Binary::Struct
-    #
-    #       endian :network
-    #     
-    #       layout :length, :uint32,
-    #              :data,   [:uchar, 48]
-    #
-    #     end
-    #
-    #     pkt = Packet.new
-    #     pkt.length = 5
-    #     pkt.data   = 'hello'
-    #
-    #     buffer = pkt.pack
-    #     # => "\x00\x00\x00\x05hello\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
-    #
-    #     new_pkt = Packet.unpack(buffer)
-    #     # => #<Packet: length: 5, data: "hello">
-    #
-    # @api public
-    #
-    class Struct
-
-      #
-      # Initializes the structure.
-      #
-      def initialize
-        # initialize the fields in order
-        self.class.layout.each do |name|
-          self[name] = self.class.default(self.class.fields[name])
-        end
-      end
-
-      #
-      # The fields in the structure.
-      #
-      # @return [Hash{Symbol => type, (type, length)}]
-      #   The field names and types.
-      #
-      # @api private
-      #
-      def self.fields
-        @fields ||= {}
-      end
-
-      #
-      # Determines if a field exists in the structure.
-      #
-      # @param [Symbol] name
-      #   The field name.
-      #
-      # @return [Boolean]
-      #   Specifies that the field exists in the structure.
-      #
-      def self.field?(name)
-        fields.has_key?(name.to_sym)
-      end
-
-      #
-      # Unpacks data into the structure.
-      #
-      # @param [String] data
-      #   The data to unpack.
-      #
-      # @param [Hash] options
-      #   Unpacking options.
-      #
-      # @option options [:little, :big, :network] :endian
-      #   The endianness to apply to the types.
-      #
-      # @return [Struct]
-      #   The newly unpacked structure.
-      #
-      def self.unpack(data,options={})
-        new().unpack(data,options)
-      end
-
-      #
-      # Determines if a field exists in the structure.
-      #
-      # @param [Symbol] name
-      #   The name of the field.
-      #
-      # @return [Boolean]
-      #   Specifies whether the field exists.
-      #
-      def field?(name)
-        self.class.field?(name)
-      end
-
-      #
-      # Reads a value from the structure.
-      #
-      # @param [Symbol] name
-      #   The field name.
-      #
-      # @return [Integer, Float, String, Struct]
-      #   The value of the field.
-      #
-      # @raise [ArgumentError]
-      #   The structure does not contain the field.
-      #
-      def [](name)
-        if field?(name) then send(name)
-        else                 raise(ArgumentError,"no such field '#{name}'")
-        end
-      end
-
-      #
-      # Writes a value to the structure.
-      #
-      # @param [Symbol] name
-      #   The field name.
-      #
-      # @param [Integer, Float, String, Struct] value
-      #   The value to write.
-      #
-      # @return [Integer, Float, String, Struct]
-      #   The value of the field.
-      #
-      # @raise [ArgumentError]
-      #   The structure does not contain the field.
-      #
-      def []=(name,value)
-        if field?(name) then send("#{name}=",value)
-        else                 raise(ArgumentError,"no such field '#{name}'")
-        end
-      end
-
-      #
-      # The values within the structure.
-      #
-      # @return [Array<Integer, Float, String, Struct>]
-      #   The values of the fields.
-      #
-      def values
-        normalize = lambda { |value|
-          case value
-          when Struct then value.values
-          else             value
-          end
-        }
-
-        self.class.layout.map do |name|
-          case (value = self[name])
-          when Array then value.map(&normalize)
-          else            normalize[value]
-          end
-        end
-      end
-
-      #
-      # Clears the fields of the structure.
-      #
-      # @return [Struct]
-      #   The cleared structure.
-      #
-      def clear
-        each_field do |struct,name,field|
-          struct[name] = self.class.default(field)
-        end
-
-        return self
-      end
-
-      #
-      # Packs the structure.
-      #
-      # @param [Hash] options
-      #   Pack options.
-      #
-      # @option options [:little, :big, :network] :endian
-      #   The endianness to apply to the types.
-      #
-      # @return [String]
-      #   The packed structure.
-      #
-      def pack(options={})
-        self.class.templates[options].pack(*values.flatten)
-      end
-
-      #
-      # Unpacks data into the structure.
-      #
-      # @param [String] data
-      #   The data to unpack.
-      #
-      # @param [Hash] options
-      #   Unpack options.
-      #
-      # @option options [:little, :big, :network] :endian
-      #   The endianness to apply to the types.
-      #
-      # @return [Struct]
-      #   The unpacked structure.
-      #
-      def unpack(data,options={})
-        values = self.class.templates[options].unpack(data)
-
-        each_field do |struct,name,(type,length)|
-          struct[name] = if length
-                           if Template::STRING_TYPES.include?(type)
-                             # string types are combined into a single String
-                             values.shift
-                           else
-                             # shift off an Array of elements
-                             values.shift(length)
-                           end
-                         else
-                           values.shift
-                         end
-        end
-
-        return self
-      end
-
-      #
-      # @see #pack
-      #
-      def to_s
-        pack
-      end
-
-      #
-      # @see #pack
-      #
-      def to_str
-        pack
-      end
-
-      #
-      # Inspects the structure.
-      #
-      # @return [String]
-      #   The inspected structure.
-      #
-      def inspect
-        "#<#{self.class}: " << self.class.layout.map { |name|
-          "#{name}: " << self[name].inspect
-        }.join(', ') << '>'
-      end
-
-      protected
-
-      #
-      # Typedefs.
-      #
-      # @return [Hash{Symbol => Symbol}]
-      #   The typedef aliases.
-      #
-      # @api private
-      #
-      def self.typedefs
-        @@typedefs ||= {}
-      end
-
-      #
-      # Defines a typedef.
-      #
-      # @param [Symbol] type
-      #   The original type.
-      #
-      # @param [Symbol] type_alias
-      #   The new type.
-      #
-      def self.typedef(type,type_alias)
-        type = typedefs.fetch(type,type)
-
-        unless (type.kind_of?(Symbol) || type < Struct)
-          raise(TypeError,"#{type.inspect} is not a Symbol or #{Struct}")
-        end
-
-        typedefs[type_alias] = typedefs.fetch(type,type)
-      end
-
-      # core typedefs
-      typedef :ulong, :pointer
-      typedef :uchar, :bool
-
-      # *_t typedefs
-      typedef :uint8,  :uint8_t
-      typedef :uint16, :uint16_t
-      typedef :uint32, :uint32_t
-      typedef :uint64, :uint64_t
-      typedef :int8,   :int8_t
-      typedef :int16,  :int16_t
-      typedef :int32,  :int32_t
-      typedef :int64,  :int64_t
-
-      # network endian types
-      typedef :uint16_be,     :uint16_net
-      typedef :uint32_be,     :uint32_net
-      typedef :uint64_be,     :uint64_net
-      typedef :int16_be,      :int16_net
-      typedef :int32_be,      :int32_net
-      typedef :int64_be,      :int64_net
-      typedef :ushort_be,     :ushort_net
-      typedef :uint_be,       :uint_net
-      typedef :ulong_be,      :ulong_net
-      typedef :ulong_long_be, :ulong_long_net
-      typedef :int_be,        :int_net
-      typedef :long_be,       :long_net
-      typedef :long_long_be,  :long_long_net
-
-      # libc typedefs
-      typedef :long,    :blkcnt_t
-      typedef :pointer, :caddr_t
-      typedef :int,     :clockid_t
-      typedef :int,     :daddr_t
-      typedef :ulong,   :dev_t
-      typedef :long,    :fd_mask
-      typedef :ulong,   :fsblkcnt_t
-      typedef :ulong,   :fsfilcnt_t
-      typedef :uint32,  :git_t
-      typedef :uint32,  :id_t
-      typedef :ulong,   :ino_t
-      typedef :int32,   :key_t
-      typedef :long,    :loff_t
-      typedef :uint32,  :mode_t
-      typedef :ulong,   :nlink_t
-      typedef :long,    :off_t
-      typedef :int32,   :pid_t
-      typedef :uint32,  :pthread_key_t
-      typedef :int32,   :pthread_once_t
-      typedef :ulong,   :pthread_t
-      typedef :long,    :quad_t
-      typedef :long,    :register_t
-      typedef :ulong,   :rlim_t
-      typedef :uint16,  :sa_family_t
-      typedef :ulong,   :size_t
-      typedef :uint32,  :socklen_t
-      typedef :long,    :suseconds_t
-      typedef :long,    :ssize_t
-      typedef :long,    :time_t
-      typedef :pointer, :timer_t
-      typedef :uint32,  :uid_t
-
-      #
-      # Sets or gets the endianness of the structure.
-      #
-      # @param [:little, :big, :network, nil] type
-      #   The new endianness.
-      #
-      # @return [:little, :big, :network, nil]
-      #   The endianness of the structure.
-      #
-      def self.endian(type=nil)
-        if type then @endian = type.to_sym
-        else         @endian
-        end
-      end
-
-      #
-      # The layout of the structure.
-      #
-      # @param [Array<(name, type)>] fields
-      #   The new fields for the structure.
-      #
-      # @return [Array<Symbol>]
-      #   The field names in order.
-      #
-      # @example
-      #   layout :length, :uint32,
-      #          :data,   [:uchar, 256]
-      #
-      def self.layout(*fields)
-        unless fields.empty?
-          @layout = []
-          @fields = {}
-
-          fields.each_slice(2) do |name,(type,length)|
-            type = typedefs.fetch(type,type)
-
-            unless (type.kind_of?(Symbol) || type < Struct)
-              raise(TypeError,"#{type.inspect} is not a Symbol or #{Struct}")
-            end
-
-            @layout      << name
-            @fields[name] = [type, length]
-
-            attr_accessor name
-          end
-        end
-
-        return (@layout ||= [])
-      end
-
-      #
-      # The templates for the structure.
-      #
-      # @return [Hash{Hash => Template}]
-      #   The templates and their options.
-      #
-      # @api semipublic
-      #
-      def self.templates
-        @templates ||= Hash.new do |hash,options|
-          fields  = each_field.map { |struct,name,field| field }
-          options = {:endian => self.endian}.merge(options)
-
-          hash[options] = template(fields,options)
-        end
-      end
-
-      #
-      # Creates a new template for the structure.
-      #
-      # @param [Array<type, (type, length)>] fields
-      #   The fields of the structure.
-      #
-      # @param [Hash] options
-      #   Template options.
-      #
-      # @return [Template]
-      #   The new template.
-      #
-      # @api semipublic
-      #
-      def self.template(fields,options={})
-        Template.new(fields,options)
-      end
-
-      #
-      # Default value for a field.
-      #
-      # @param [type, (type, length)] type
-      #   The type of the field.
-      #
-      # @return [Integer, Float, String, Struct]
-      #   The default value for the type.
-      #
-      # @api private
-      #
-      def self.default(type)
-        type, length = type
-
-        if length
-          if Template::STRING_TYPES.include?(type)
-            # arrays of chars should be Strings
-            String.new
-          else
-            # create an array of values
-            Array.new(length) { |index| default(type) }
-          end
-        else
-          if type.kind_of?(Symbol)
-            if    Template::INT_TYPES.include?(type)    then 0
-            elsif Template::FLOAT_TYPES.include?(type)  then 0.0
-            elsif Template::CHAR_TYPES.include?(type)   then "\0"
-            elsif Template::STRING_TYPES.include?(type) then ''
-            end
-          elsif type < Struct
-            type.new
-          end
-        end
-      end
-      
-      #
-      # Enumerates the fields of the structure, and all nested structures.
-      #
-      # @yield [struct, name, type]
-      #   The given block will be passed each structure, field name and field
-      #   type.
-      #
-      # @yieldparam [Struct] struct
-      #   The structure class.
-      #
-      # @yieldparam [Symbol] name
-      #   The name of the field.
-      #
-      # @yieldparam [type, (type, length)] type
-      #   The type of the field.
-      #
-      # @return [Enumerator]
-      #   If no block is given, an Enumerator will be returned.
-      #
-      # @api private
-      #
-      def self.each_field(&block)
-        return enum_for(__method__) unless block
-
-        layout.each do |name|
-          type, length = field = fields[name]
-
-          if type.kind_of?(Symbol)
-            yield self, name, field
-          elsif type < Struct
-            if length
-              length.times { type.each_field(&block) }
-            else
-              type.each_field(&block)
-            end
-          end
-        end
-      end
-
-      #
-      # Enumerates the fields of the structure, and all nested structure.
-      #
-      # @yield [struct, name, type]
-      #   The given block will be passed each structure, field name and type.
-      #
-      # @yieldparam [Struct] struct
-      #   The structure instance.
-      #
-      # @yieldparam [Symbol] name
-      #   The name of the field.
-      #
-      # @yieldparam [type, (type, length)] type
-      #   The type of the field.
-      #
-      # @return [Enumerator]
-      #   If no block is given, an Enumerator will be returned.
-      #
-      # @api private
-      #
-      def each_field(&block)
-        return enum_for(__method__) unless block
-
-        self.class.layout.each do |name|
-          type, length = field = self.class.fields[name]
-
-          if type.kind_of?(Symbol)
-            yield self, name, field
-          elsif type < Struct
-            if length
-              self[name].each { |struct| struct.each_field(&block) }
-            else
-              self[name].each_field(&block)
-            end
-          end
-        end
-      end
-
-    end
-  end
-end