ruby-macho 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4fdf0c3007545c3c9a84dacc832b803fc83edfe4aef0513eba857f14fcd2d1
-  data.tar.gz: 0dd36193221a6d9f25084b5d8dea8f17eb8165a1f304e2d0006433ade11d61b8
+  metadata.gz: a6043ad4ddee8f973862b3f37626351bce8bcd9a190ec5e3f87dbbc169185661
+  data.tar.gz: 95afb17f5b95f4c06e1c67ac51a8ea38903fe629b7914d5a67701509c2cad040
 SHA512:
-  metadata.gz: a07521accccc3e50119811ca36392c9ecc579dd0d8a238e8dcec5473f75325a2017a367d58212bc8fd1287e78f0b043f19546cf37eaa95c5c7f65623e7d3e015
-  data.tar.gz: 16f243d60a944e725795bb77b6c2a301e5be7939df83c70c9929f23346792f7854c9b5ad626ea2bdf301155f882f43b934e12064efdc709723a6321fc13a83d5
+  metadata.gz: 55be478649522a73fe487013c9ff32378f773b4d21b1657d584e4436cbf3d4a5462482c6a1d6b50ae34e2506051905dd1349b8ef436d80423658e70a0ccc0315
+  data.tar.gz: 0524245cee9c8a416734449e9f2c3ac3b7a34b2922ff1c1468edf38fe45255f912e9cd80b677cc67692b2c976af41ce4d75a88dcbef5ffd2ac0e5259dbde5afd

data/lib/macho.rb

@@ -12,7 +12,7 @@ require_relative "macho/tools"
 # The primary namespace for ruby-macho.
 module MachO
   # release version
-  VERSION = "2.1.0".freeze
+  VERSION = "2.2.0".freeze
 
   # Opens the given filename as a MachOFile or FatFile, depending on its magic.
   # @param filename [String] the file being opened

data/lib/macho/fat_file.rb

@@ -11,6 +11,10 @@ module MachO
     # @return [String] the filename loaded from, or nil if loaded from a binary string
     attr_accessor :filename
 
+    # @return [Hash] any parser options that the instance was created with
+    # @note Options specified in a {FatFile} trickle down into the internal {MachOFile}s.
+    attr_reader :options
+
     # @return [Headers::FatHeader] the file's header
     attr_reader :header
 
@@ -49,9 +53,7 @@ module MachO
       machos.each do |macho|
         macho_offset = Utils.round(offset, 2**macho.segment_alignment)
 
-        if !fat64 && macho_offset > (2**32 - 1)
-          raise FatArchOffsetOverflowError, macho_offset
-        end
+        raise FatArchOffsetOverflowError, macho_offset if !fat64 && macho_offset > (2**32 - 1)
 
         macho_pads[macho] = Utils.padding_for(offset, 2**macho.segment_alignment)
 
@@ -72,30 +74,36 @@ module MachO
 
     # Creates a new FatFile instance from a binary string.
     # @param bin [String] a binary string containing raw Mach-O data
+    # @param opts [Hash] options to control the parser with
+    # @note see {MachOFile#initialize} for currently valid options
     # @return [FatFile] a new FatFile
-    def self.new_from_bin(bin)
+    def self.new_from_bin(bin, **opts)
       instance = allocate
-      instance.initialize_from_bin(bin)
+      instance.initialize_from_bin(bin, opts)
 
       instance
     end
 
     # Creates a new FatFile from the given filename.
     # @param filename [String] the fat file to load from
+    # @param opts [Hash] options to control the parser with
+    # @note see {MachOFile#initialize} for currently valid options
     # @raise [ArgumentError] if the given file does not exist
-    def initialize(filename)
+    def initialize(filename, **opts)
       raise ArgumentError, "#{filename}: no such file" unless File.file?(filename)
 
       @filename = filename
+      @options = opts
       @raw_data = File.open(@filename, "rb", &:read)
       populate_fields
     end
 
-    # Initializes a new FatFile instance from a binary string.
+    # Initializes a new FatFile instance from a binary string with the given options.
     # @see new_from_bin
     # @api private
-    def initialize_from_bin(bin)
+    def initialize_from_bin(bin, opts)
       @filename = nil
+      @options = opts
       @raw_data = bin
       populate_fields
     end
@@ -358,7 +366,7 @@ module MachO
       machos = []
 
       fat_archs.each do |arch|
-        machos << MachOFile.new_from_bin(@raw_data[arch.offset, arch.size])
+        machos << MachOFile.new_from_bin(@raw_data[arch.offset, arch.size], **options)
       end
 
       machos

data/lib/macho/headers.rb

@@ -241,6 +241,10 @@ module MachO
     # @api private
     CPU_SUBTYPE_ARM64_32_V8 = 1
 
+    # the e (A12) sub-type for `CPU_TYPE_ARM64`
+    # @api private
+    CPU_SUBTYPE_ARM64E = 2
+
     # the lowest common sub-type for `CPU_TYPE_MC88000`
     # @api private
     CPU_SUBTYPE_MC88000_ALL = 0
@@ -350,6 +354,7 @@ module MachO
       CPU_TYPE_ARM64 => {
         CPU_SUBTYPE_ARM64_ALL => :arm64,
         CPU_SUBTYPE_ARM64_V8 => :arm64v8,
+        CPU_SUBTYPE_ARM64E => :arm64e,
       }.freeze,
       CPU_TYPE_ARM64_32 => {
         CPU_SUBTYPE_ARM64_32_V8 => :arm64_32v8,

data/lib/macho/macho_file.rb

@@ -9,10 +9,13 @@ module MachO
   class MachOFile
     extend Forwardable
 
-    # @return [String] the filename loaded from, or nil if loaded from a binary
+    # @return [String, nil] the filename loaded from, or nil if loaded from a binary
     #  string
     attr_accessor :filename
 
+    # @return [Hash] any parser options that the instance was created with
+    attr_reader :options
+
     # @return [Symbol] the endianness of the file, :big or :little
     attr_reader :endianness
 
@@ -27,30 +30,36 @@ module MachO
 
     # Creates a new instance from a binary string.
     # @param bin [String] a binary string containing raw Mach-O data
+    # @param opts [Hash] options to control the parser with
+    # @option opts [Boolean] :permissive whether to ignore unknown load commands
     # @return [MachOFile] a new MachOFile
-    def self.new_from_bin(bin)
+    def self.new_from_bin(bin, **opts)
       instance = allocate
-      instance.initialize_from_bin(bin)
+      instance.initialize_from_bin(bin, opts)
 
       instance
     end
 
     # Creates a new instance from data read from the given filename.
     # @param filename [String] the Mach-O file to load from
+    # @param opts [Hash] options to control the parser with
+    # @option opts [Boolean] :permissive whether to ignore unknown load commands
     # @raise [ArgumentError] if the given file does not exist
-    def initialize(filename)
+    def initialize(filename, **opts)
       raise ArgumentError, "#{filename}: no such file" unless File.file?(filename)
 
       @filename = filename
+      @options = opts
       @raw_data = File.open(@filename, "rb", &:read)
       populate_fields
     end
 
-    # Initializes a new MachOFile instance from a binary string.
+    # Initializes a new MachOFile instance from a binary string with the given options.
     # @see MachO::MachOFile.new_from_bin
     # @api private
-    def initialize_from_bin(bin)
+    def initialize_from_bin(bin, opts)
       @filename = nil
+      @options = opts
       @raw_data = bin
       populate_fields
     end
@@ -146,16 +155,13 @@ module MachO
     def insert_command(offset, lc, options = {})
       context = LoadCommands::LoadCommand::SerializationContext.context_for(self)
       cmd_raw = lc.serialize(context)
+      fileoff = offset + cmd_raw.bytesize
 
-      if offset < header.class.bytesize || offset + cmd_raw.bytesize > low_fileoff
-        raise OffsetInsertionError, offset
-      end
+      raise OffsetInsertionError, offset if offset < header.class.bytesize || fileoff > low_fileoff
 
       new_sizeofcmds = sizeofcmds + cmd_raw.bytesize
 
-      if header.class.bytesize + new_sizeofcmds > low_fileoff
-        raise HeaderPadError, @filename
-      end
+      raise HeaderPadError, @filename if header.class.bytesize + new_sizeofcmds > low_fileoff
 
       # update Mach-O header fields to account for inserted load command
       update_ncmds(ncmds + 1)
@@ -178,9 +184,8 @@ module MachO
       context = LoadCommands::LoadCommand::SerializationContext.context_for(self)
       cmd_raw = new_lc.serialize(context)
       new_sizeofcmds = sizeofcmds + cmd_raw.bytesize - old_lc.cmdsize
-      if header.class.bytesize + new_sizeofcmds > low_fileoff
-        raise HeaderPadError, @filename
-      end
+
+      raise HeaderPadError, @filename if header.class.bytesize + new_sizeofcmds > low_fileoff
 
       delete_command(old_lc)
       insert_command(old_lc.view.offset, new_lc)
@@ -511,6 +516,7 @@ module MachO
     # @raise [LoadCommandError] if an unknown load command is encountered
     # @api private
     def populate_load_commands
+      permissive = options.fetch(:permissive, false)
       offset = header.class.bytesize
       load_commands = []
 
@@ -519,11 +525,16 @@ module MachO
         cmd = @raw_data.slice(offset, 4).unpack(fmt).first
         cmd_sym = LoadCommands::LOAD_COMMANDS[cmd]
 
-        raise LoadCommandError, cmd if cmd_sym.nil?
+        raise LoadCommandError, cmd unless cmd_sym || permissive
+
+        # If we're here, then either cmd_sym represents a valid load
+        # command *or* we're in permissive mode.
+        klass = if (klass_str = LoadCommands::LC_STRUCTURES[cmd_sym])
+          LoadCommands.const_get klass_str
+        else
+          LoadCommands::LoadCommand
+        end
 
-        # why do I do this? i don't like declaring constants below
-        # classes, and i need them to resolve...
-        klass = LoadCommands.const_get LoadCommands::LC_STRUCTURES[cmd_sym]
         view = MachOView.new(@raw_data, endianness, offset)
         command = klass.new_from_bin(view)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-macho
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies: []
 description: A library for viewing and manipulating Mach-O files in Ruby.
 email: william@yossarian.net
@@ -42,15 +42,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: ruby-macho - Mach-O file analyzer.