ronin-support 1.0.0 → 1.0.2

data/lib/ronin/support/binary/stack.rb

@@ -36,7 +36,7 @@ module Ronin
       #
       # Creating a new stack:
       #
-      #     stack = Stack.new
+      #     stack = Binary::Stack.new
       #     # => #<Ronin::Support::Binary::Stack: "">
       #     stack.push 0x41414141
       #     # => #<Ronin::Support::Binary::Stack: "AAAA\x00\x00\x00\x00">
@@ -49,7 +49,7 @@ module Ronin
       #
       # Creating a stack from an existing String:
       #
-      #     stack = Stack.new("\x41\x00\x00\x00\x00\x00\x00\x00\x42\x00\x00\x00\x00\x00\x00\x00")
+      #     stack = Binary::Stack.new("\x41\x00\x00\x00\x00\x00\x00\x00\x42\x00\x00\x00\x00\x00\x00\x00")
       #     stack[0]
       #     # => 65
       #     stack[8]
@@ -125,7 +125,7 @@ module Ronin
             @size   = @string.bytesize
             @length = @size / @machine_word.size
           else
-            @string = String.new("", encoding: Encoding::ASCII_8BIT)
+            @string = String.new
             @size   = 0
             @length = 0
           end
@@ -152,7 +152,7 @@ module Ronin
                    else              index
                    end
 
-          if offset+@machine_word.size > @size
+          if (offset + @machine_word.size) > @size
             raise(IndexError,"index #{index} is out of bounds: 0...#{@size}")
           end
 
@@ -184,12 +184,11 @@ module Ronin
                    else              index
                    end
 
-          if offset+@machine_word.size > @size
+          if (offset + @machine_word.size) > @size
             raise(IndexError,"index #{index} is out of bounds: 0...#{@size}")
           end
 
-          data = @machine_word.pack(value)
-          @string[offset,@machine_word.size] = data
+          @string[offset,@machine_word.size] = @machine_word.pack(value)
           return value
         end
 

data/lib/ronin/support/binary/struct/member.rb

@@ -22,6 +22,9 @@ module Ronin
   module Support
     module Binary
       class Struct < Memory
+        #
+        # Represents a member defined within a {Struct}.
+        #
         class Member
 
           # The name of the structure member.
@@ -51,10 +54,9 @@ module Ronin
           #   The optional default value for the structure's field.
           #
           def initialize(name,type_signature, default: nil)
-            @name = name
+            @name           = name
             @type_signature = type_signature
-
-            @default = default
+            @default        = default
           end
 
           #

data/lib/ronin/support/binary/struct.rb

@@ -37,10 +37,10 @@ module Ronin
       # ### Defining Members
       #
       #     class Point < Ronin::Support::Binary::Struct
-      #     
+      #
       #       member :x, :int32
       #       member :y, :int32
-      #     
+      #
       #     end
       #
       # ### Initializing Structs
@@ -69,10 +69,10 @@ module Ronin
       # ### Packing Structs
       #
       #     class Point < Ronin::Support::Binary::Struct
-      #     
+      #
       #       member :x, :int32
       #       member :y, :int32
-      #     
+      #
       #     end
       #
       #     point = Point.new(x: 10, y: -1)
@@ -82,12 +82,12 @@ module Ronin
       # ### Unpacking Structs
       #
       #     class Point < Ronin::Support::Binary::Struct
-      #     
+      #
       #       member :x, :int32
       #       member :y, :int32
-      #     
+      #
       #     end
-      #     
+      #
       #     point = Point.unpack("\x00\x00\x00\x01\xFF\xFF\xFF\xFF")
       #     point.x
       #     # => 1
@@ -95,30 +95,30 @@ module Ronin
       #     # => -1
       #
       # ### Inheriting Structs
-      #     
+      #
       #     class Point < Ronin::Support::Binary::Struct
-      #     
+      #
       #       member :x, :int32
       #       member :y, :int32
-      #     
+      #
       #     end
-      #     
+      #
       #     class Point3D < Point
-      #     
+      #
       #       member :z, :int32
       #
       #     end
-      #     
+      #
       #     point   = Point.new(x: 100, y: 42)
       #     point3d = Point3D.new(x: 100, y: 42, z: -1)
       #
       # ### Array Fields
       #
       #     class MyStruct < Ronin::Support::Binary::Struct
-      #     
+      #
       #       member :x,    :uint32
       #       member :nums, [:uint8, 10]
-      #     
+      #
       #     end
       #
       #     struct = MyStruct.new
@@ -129,12 +129,12 @@ module Ronin
       # ### Unbounded Array Fields
       #
       #     class MyStruct < Ronin::Support::Binary::Struct
-      #     
+      #
       #       member :length,  :uint32
       #       member :payload, (:uint8..)
-      #     
+      #
       #     end
-      #     
+      #
       #     struct = MyStruct.new
       #     struct.payload = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08]
       #     struct.pack
@@ -143,14 +143,14 @@ module Ronin
       # ### Struct Endianness
       #
       #     class MyStruct < Ronin::Support::Binary::Struct
-      #     
+      #
       #       platform endian: :big
-      #     
+      #
       #       member :x, :uint32
       #       member :y, :uint32
-      #     
+      #
       #     end
-      #     
+      #
       #     struct = MyStruct.new
       #     struct.x = 0xAABB
       #     struct.y = 0xCCDD
@@ -160,13 +160,13 @@ module Ronin
       # ### Struct Architecture
       #
       #     class MyStruct < Ronin::Support::Binary::Struct
-      #     
+      #
       #       platform arch: :arm64_be
-      #     
+      #
       #       member :x, :int
       #       member :y, :int
       #       member :f, :double
-      #     
+      #
       #     end
       #
       #     struct = MyStruct.new
@@ -177,16 +177,16 @@ module Ronin
       #     # => "\x00\x00\x00d\xFF\xFF\xFF\x9C@<\xA5\xDC\x1Ac\xC1\xF8"
       #
       # ### Struct Operating System (OS)
-      #    
+      #
       #     class MyStruct < Ronin::Support::Binary::Struct
-      #     
+      #
       #       platform arch: :x86_64, os: :windows
-      #     
+      #
       #       member :x, :long
       #       member :y, :long
-      #     
+      #
       #     end
-      #     
+      #
       #     struct = MyStruct.new
       #     struct.x = 255
       #     struct.y = -1
@@ -196,20 +196,20 @@ module Ronin
       # ### Struct Alignment
       #
       #     class Pixel < Ronin::Support::Binary::Struct
-      #     
+      #
       #       align 4
-      #     
+      #
       #       member :r, :uint8
       #       member :g, :uint8
       #       member :b, :uint8
-      #     
+      #
       #     end
       #
       #     class PixelBuf < Ronin::Support::Binary::Struct
-      #     
+      #
       #       member :count, :uint8
       #       member :pixels, [Pixel, 255]
-      #     
+      #
       #     end
       #
       #     pixelbuf = PixelBuf.new
@@ -226,12 +226,12 @@ module Ronin
       # ### Disable Struct Padding
       #
       #     class MyStruct < Ronin::Support::Binary::Struct
-      #     
+      #
       #       padding false
-      #     
+      #
       #       member :c, :char
       #       member :i, :int32
-      #     
+      #
       #     end
       #
       #     struct = MyStruct.new
@@ -259,13 +259,13 @@ module Ronin
         #
         # @example Initiializing a new struct from a buffer:
         #   class MyStruct < Ronin::Support::Binary::Struct
-        #   
+        #
         #     member :x,    :uint32
         #     member :f,    :double
         #     member :nums, [:uint8, 10]
-        #   
+        #
         #   end
-        #   
+        #
         #   struct = MyStruct.new("\x01\x00\x00\x00\x00\x00\x00\x00333333\xD3?\x01\x02\x03\x00\x00\x00\x00\x00\x00\x00")
         #   struct.x
         #   # => 1
@@ -328,12 +328,12 @@ module Ronin
         #
         # @example
         #   class MyStruct < Ronin::Support::Binary::Struct
-        #   
+        #
         #     member :x, :uint32
         #     member :y, :uint32
-        #   
+        #
         #   end
-        #   
+        #
         #   MyStruct.size
         #   # => 8
         #
@@ -412,13 +412,13 @@ module Ronin
         #
         # @example
         #   class MyStruct < Ronin::Support::Binary::Struct
-        #   
+        #
         #     member :x,    :uint32
         #     member :f,    :double
         #     member :nums, [:uint8, 10]
-        #   
+        #
         #   end
-        #   
+        #
         #   MyStruct.pack(x: 1, f: 0.3, nums: [1,2,3])
         #   # => "\x01\x00\x00\x00\x00\x00\x00\x00333333\xD3?\x01\x02\x03\x00\x00\x00\x00\x00\x00\x00"
         #
@@ -439,13 +439,13 @@ module Ronin
         #
         # @example
         #   class MyStruct < Ronin::Support::Binary::Struct
-        #   
+        #
         #     member :x,    :uint32
         #     member :f,    :double
         #     member :nums, [:uint8, 10]
-        #   
+        #
         #   end
-        #   
+        #
         #   struct = MyStruct.unpack("\x01\x00\x00\x00\x00\x00\x00\x00333333\xD3?\x01\x02\x03\x00\x00\x00\x00\x00\x00\x00")
         #
         # @api public
@@ -465,13 +465,13 @@ module Ronin
         #
         # @example
         #   class MyStruct < Ronin::Support::Binary::Struct
-        #   
+        #
         #     member :x,    :uint32
         #     member :f,    :double
         #     member :nums, [:uint8, 10]
-        #   
+        #
         #   end
-        #   
+        #
         #   file   = File.new('binary.dat','b')
         #   struct = MyStruct.read_from(file)
         #
@@ -480,7 +480,7 @@ module Ronin
         # @api public
         #
         def self.read_from(io)
-          new().read_from(io)
+          new.read_from(io)
         end
 
         #
@@ -497,13 +497,13 @@ module Ronin
         #
         # @example
         #   class MyStruct < Ronin::Support::Binary::Struct
-        #   
+        #
         #     member :x,    :uint32
         #     member :f,    :double
         #     member :nums, [:uint8, 10]
-        #   
+        #
         #   end
-        #   
+        #
         #   struct = MyStruct.new("\x01\x00\x00\x00\x00\x00\x00\x00333333\xD3?\x01\x02\x03\x00\x00\x00\x00\x00\x00\x00")
         #   struct[:x]
         #   # => 1
@@ -519,15 +519,21 @@ module Ronin
             case member.type
             when CTypes::UnboundedArrayType
               # XXX: but how do we handle an unbounded array of structs?
-              @cache[name] ||= (
-                slice = byteslice(member.offset,size - member.offset)
-                Binary::Array.new(member.type.type,slice)
-              )
+              @cache[name] ||= begin
+                                 offset = member.offset
+                                 length = size - member.offset
+                                 slice  = byteslice(offset,length)
+
+                                 Binary::Array.new(member.type.type,slice)
+                               end
             when CTypes::ObjectType
-              @cache[name] ||= (
-                slice = byteslice(member.offset,member.type.size)
-                member.type.unpack(slice)
-              )
+              @cache[name] ||= begin
+                                 offset = member.offset
+                                 length = member.type.size
+                                 slice  = byteslice(offset,length)
+
+                                 member.type.unpack(slice)
+                               end
             else
               data = super(member.offset,member.type.size)
               member.type.unpack(data)
@@ -554,13 +560,13 @@ module Ronin
         #
         # @example
         #   class MyStruct < Ronin::Support::Binary::Struct
-        #   
+        #
         #     member :x,    :uint32
         #     member :f,    :double
         #     member :nums, [:uint8, 10]
-        #   
+        #
         #   end
-        #   
+        #
         #   struct = MyStruct.new
         #   struct[:x] = 1
         #   struct[:x]
@@ -606,7 +612,7 @@ module Ronin
         def each(&block)
           return enum_for(__method__) unless block_given?
 
-          @type.members.each_key  do |name|
+          @type.members.each_key do |name|
             yield name, self[name]
           end
         end
@@ -620,9 +626,7 @@ module Ronin
         # @api public
         #
         def to_h
-          Hash[@type.members.keys.map { |name|
-            [name, self[name]]
-          }]
+          each.to_h
         end
 
         #
@@ -634,9 +638,7 @@ module Ronin
         # @api public
         #
         def to_a
-          @type.members.keys.map do |name|
-            self[name]
-          end
+          each.map { |name,value| value }
         end
 
         extend CTypes::Mixin
@@ -755,7 +757,7 @@ module Ronin
         # @api semipublic
         #
         def self.type_resolver
-          @resolver ||= CTypes::TypeResolver.new(type_system)
+          @type_resolver ||= CTypes::TypeResolver.new(type_system)
         end
 
         #
@@ -771,7 +773,7 @@ module Ronin
         #   class MyStruct < Ronin::Support::Binary::Struct
         #     member :x, :uint32
         #   end
-        #   
+        #
         #   struct = MyStruct.new
         #   struct.x = 0x11223344
         #
@@ -779,7 +781,7 @@ module Ronin
         #   class MyStruct < Ronin::Support::Binary::Struct
         #     member :nums, [:uint32, 10]
         #   end
-        #   
+        #
         #   struct = MyStruct.new
         #   struct.x = [0x11111111, 0x22222222, 0x33333333, 0x44444444]
         #
@@ -787,7 +789,7 @@ module Ronin
         #   class MyStruct < Ronin::Support::Binary::Struct
         #     member :payload, :uint8..
         #   end
-        #   
+        #
         #   struct = MyStruct.new
         #   struct.payloads = [0x1, 0x2, 0x3, 0x4]
         #

data/lib/ronin/support/binary/template.rb

@@ -36,10 +36,6 @@ module Ronin
       # * `:int16` - signed 16-bit integer.
       # * `:int32` - signed 32-bit integer.
       # * `:int64` - signed 64-bit integer.
-      # * `:uint16_le` - unsigned 16-bit integer, little endian.
-      # * `:uint32_le` - unsigned 32-bit integer, little endian.
-      # * `:uint16_be` - unsigned 16-bit integer, big endian.
-      # * `:uint32_be` - unsigned 32-bit integer, big endian.
       # * `:uchar` - unsigned character.
       # * `:ushort` - unsigned short integer, native endian.
       # * `:uint` - unsigned integer, native endian.
@@ -151,6 +147,7 @@ module Ronin
 
           @fields = []
           @types  = []
+
           @pack_string = String.new
 
           fields.each do |field|
@@ -208,7 +205,7 @@ module Ronin
 
             values.pack(@pack_string)
           else
-            buffer = String.new('', encoding: Encoding::ASCII_8BIT)
+            buffer = String.new
 
             @types.each do |type|
               # shift off the next value and pack it

data/lib/ronin/support/binary/unhexdump/parser.rb

@@ -46,9 +46,7 @@ module Ronin
           )
 
           # Visible characters
-          VISIBLE_CHARS = Hash[
-            Chars::VISIBLE.chars.sort.zip(Chars::VISIBLE.bytes.sort)
-          ]
+          VISIBLE_CHARS = Chars::VISIBLE.chars.sort.zip(Chars::VISIBLE.bytes.sort).to_h
 
           # Escaped characters
           CHARS = {
@@ -261,7 +259,7 @@ module Ronin
             case @type
             when CTypes::CharType
               @base  = 8
-              @chars = CHARS 
+              @chars = CHARS
             end
           end
 
@@ -310,6 +308,8 @@ module Ronin
                 starts_repeating_at  = previous_address + previous_row_size
               else
                 address, row = parse_line(line)
+
+                # remember the first address
                 first_address ||= address
 
                 if previous_row_repeats
@@ -317,8 +317,8 @@ module Ronin
                   range     = starts_repeating_at...address
                   addresses = range.step(previous_row_size)
 
-                  addresses.each do |address|
-                    yield address, previous_row
+                  addresses.each do |next_address|
+                    yield next_address, previous_row
                   end
 
                   previous_row_repeats = false
@@ -368,7 +368,6 @@ module Ronin
             buffer = String.new(encoding: Encoding::ASCII_8BIT)
 
             length = parse(hexdump) do |address,row|
-              first_address ||= address
               buffer << pack(row)
             end
 
@@ -385,7 +384,7 @@ module Ronin
           #   The parsed address.
           #
           # @api private
-          #   
+          #
           def parse_address(address)
             address.to_i(@address_base)
           end
@@ -400,7 +399,7 @@ module Ronin
           #   The parsed Integer.
           #
           # @api private
-          #   
+          #
           def parse_int(string)
             string.to_i(@base)
           end
@@ -415,7 +414,7 @@ module Ronin
           #   The parsed integer or byte value of the character.
           #
           def parse_char_or_int(string)
-            @chars.fetch(string) do |string|
+            @chars.fetch(string) do
               string.to_i(@base)
             end
           end
@@ -459,6 +458,7 @@ module Ronin
               end
             else
               address, *numbers = line.split
+
               address = parse_address(address)
               numbers.map!(&@parse_method)
 
@@ -480,7 +480,7 @@ module Ronin
           #   The packed segment.
           #
           # @api private
-          #   
+          #
           def pack(values)
             values.pack(@type.pack_string * values.length)
           end