memory_io 0.2.0 → 1.0.0

data/lib/memory_io/util.rb

@@ -1,11 +1,35 @@
 # frozen_string_literal: true
 
-require 'ostruct'
 require 'dentaku'
 
 module MemoryIO
   # Defines utility methods.
   module Util
+    # A simple class to be returned for getting file permissions.
+    class FilePermission
+      attr_reader :readable, :writable
+      # Alias the two methods to fit Ruby's method naming convention.
+      alias readable? readable
+      alias writable? writable
+
+      def initialize(file)
+        stat = File.stat(file)
+        @readable = stat.readable_real?
+        @writable = stat.writable_real?
+        # we do a trick here because /proc/[pid]/mem might be marked as writeable but fails at sysopen.
+        begin
+          @readable && File.open(file, 'rb', &:close)
+        rescue Errno::EACCES
+          @readable = false
+        end
+        begin
+          @writable && File.open(file, 'wb', &:close)
+        rescue Errno::EACCES
+          @writable = false
+        end
+      end
+    end
+
     module_function
 
     # Convert input into snake-case.
@@ -39,26 +63,12 @@ module MemoryIO
     # @param [String] file
     #   File name.
     #
-    # @return [#readable?, #writable?, nil]
-    #   Struct with two boolean method.
-    #   +nil+ for file not exists or is inaccessible.
+    # @return [MemoryIO::Util::FilePermission?]
+    #   +nil+ is returned if file does not exist or is inaccessible.
     def file_permission(file)
       return nil unless File.file?(file)
 
-      stat = File.stat(file)
-      # we do a trick here because /proc/[pid]/mem might be marked as readable but fails at sysopen.
-      os = OpenStruct.new(readable?: stat.readable_real?, writable?: stat.writable_real?)
-      begin
-        os.readable? && File.open(file, 'rb').close
-      rescue Errno::EACCES
-        os[:readable?] = false
-      end
-      begin
-        os.writable? && File.open(file, 'wb').close
-      rescue Errno::EACCES
-        os[:writable?] = false
-      end
-      os
+      FilePermission.new(file)
     end
 
     # Evaluate string safely.
@@ -68,25 +78,53 @@ module MemoryIO
     # @param [{Symbol => Integer}] vars
     #   Predefined variables
     #
-    # @return [Integer]
-    #   Result.
+    # @return [Integer?]
+    #   Result, or +nil+ if +str+ is not a valid expression.
     #
     # @example
     #   Util.safe_eval('heap + 0x10 * pp', heap: 0xde00, pp: 8)
     #   #=> 56960 # 0xde80
+    #
+    #   Util.safe_eval('0xzz')
+    #   #=> nil
     def safe_eval(str, **vars)
       return str if str.is_a?(Integer)
 
-      # dentaku 2 doesn't support hex
-      str = str.gsub(/0x[0-9a-zA-Z]+/) { |c| c.to_i(16) }
       Dentaku::Calculator.new.store(vars).evaluate(str)
     end
 
+    # @api private
+    #
+    # Read exactly +size+ bytes from +stream+.
+    #
+    # @param [#read] stream
+    #   Stream to read.
+    # @param [Integer] size
+    #   Number of bytes to read.
+    #
+    # @return [String]
+    #   The bytes read.
+    #
+    # @raise [EOFError]
+    #   Fewer than +size+ bytes remain in +stream+.
+    #
+    # @example
+    #   Util.read_exactly(StringIO.new('1234'), 8)
+    #   # EOFError: Requires 0x8 bytes, but only 0x4 bytes remain
+    def read_exactly(stream, size)
+      str = stream.read(size)
+      remain = str.nil? ? 0 : str.size
+      raise ::EOFError, format('Requires 0x%x bytes, but only 0x%x bytes remain', size, remain) if remain < size
+
+      str
+    end
+
     # Unpack a string into an integer.
-    # Little endian is used.
     #
     # @param [String] str
     #   String.
+    # @param [:little, :big] endian
+    #   Byte order of +str+.
     #
     # @return [Integer]
     #   Result.
@@ -96,12 +134,14 @@ module MemoryIO
     #   #=> 255
     #   Util.unpack("@\xE2\x01\x00")
     #   #=> 123456
-    def unpack(str)
-      str.bytes.reverse.reduce(0) { |s, c| s * 256 + c }
+    #   Util.unpack("\x00\x01\xE2@", :big)
+    #   #=> 123456
+    def unpack(str, endian = :little)
+      bytes = endian == :little ? str.bytes.reverse : str.bytes
+      bytes.reduce(0) { |s, c| (s * 256) + c }
     end
 
     # Pack an integer into +b+ bytes.
-    # Little endian is used.
     #
     # @param [Integer] val
     #   The integer to pack.
@@ -109,6 +149,8 @@ module MemoryIO
     #   only lower +b+ bytes in +val+ will be packed.
     #
     # @param [Integer] b
+    # @param [:little, :big] endian
+    #   Byte order to pack +val+ in.
     #
     # @return [String]
     #   Packing result with length +b+.
@@ -116,8 +158,12 @@ module MemoryIO
     # @example
     #   Util.pack(0x123, 4)
     #   #=> "\x23\x01\x00\x00"
-    def pack(val, b)
-      Array.new(b) { |i| (val >> (i * 8)) & 0xff }.pack('C*')
+    #   Util.pack(0x123, 4, :big)
+    #   #=> "\x00\x00\x01\x23"
+    def pack(val, b, endian = :little)
+      bytes = Array.new(b) { |i| (val >> (i * 8)) & 0xff }
+      bytes.reverse! if endian == :big
+      bytes.pack('C*')
     end
 
     # Remove extension name (.so) and version in library name.
@@ -135,9 +181,13 @@ module MemoryIO
     #   #=> 'libcrypto'
     #   Util.trim_libname('not_a_so')
     #   #=> 'not_a_so'
+    #   Util.trim_libname('ld-linux-x86-64.so.2')
+    #   #=> 'ld'
     def trim_libname(name)
+      return 'ld' if name.start_with?('ld-')
+
       type1 = '(-[\d.]+)?\.so$'
-      type2 = '\.so.\d+[\d.]+$'
+      type2 = '\.so.[\.\d]+$'
       name.sub(/#{type1}|#{type2}/, '')
     end
   end

data/lib/memory_io/version.rb

@@ -2,5 +2,5 @@
 
 module MemoryIO
   # Current gem version.
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/lib/memory_io.rb

@@ -9,12 +9,36 @@ module MemoryIO
   # Get a process by process id.
   #
   # @param [Integer] pid
-  #   Process Id in linux.
+  #   Process id in Linux.
+  # @param [:little, :big, :native, nil] endian
+  #   Byte order of the process's memory.
+  # @param [Integer?] pointer_size
+  #   Size of a pointer in the process, in bytes.
+  #
+  #   Both are taken from the process's executable when not given.
   #
   # @return [MemoryIO::Process]
   #   A process object for further usage.
-  def attach(pid)
-    MemoryIO::Process.new(pid)
+  #
+  # @raise [MemoryIO::ProcessNotFoundError]
+  #   The memory of +pid+ is not accessible.
+  #
+  # @example
+  #   process = MemoryIO.attach(`pidof victim`.to_i)
+  #   process.read('heap', 8)
+  # @example
+  #   # a program started through an interpreter is described by the
+  #   # interpreter, so state the context of the program instead
+  #   MemoryIO.attach(`pidof victim32`.to_i, pointer_size: 4)
+  #
+  # @note
+  #   The context is read from +/proc/[pid]/exe+, which names the interpreter
+  #   when the process was started through one. Pass +endian+ and
+  #   +pointer_size+ for such a process, whose context may differ from
+  #   the interpreter running it.
+  # @see MemoryIO::Process#initialize
+  def attach(pid, endian: nil, pointer_size: nil)
+    MemoryIO::Process.new(pid, endian: endian, pointer_size: pointer_size)
   end
 end
 

metadata

@@ -1,29 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: memory_io
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - david942j
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dentaku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: elftools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.11
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.11
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +105,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -96,17 +143,22 @@ dependencies:
         version: '0.9'
 description: 'Read/Write complicated structures in memory easily.
 
-'
+  '
 email:
 - david942j@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/memory_io.rb
+- lib/memory_io/context.rb
+- lib/memory_io/error.rb
 - lib/memory_io/io.rb
+- lib/memory_io/logger.rb
 - lib/memory_io/process.rb
+- lib/memory_io/stream.rb
 - lib/memory_io/types/basic/number.rb
 - lib/memory_io/types/clang/c_str.rb
 - lib/memory_io/types/cpp/string.rb
@@ -118,8 +170,8 @@ files:
 homepage: https://github.com/david942j/memory_io
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -127,15 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: memory_io
 test_files: []