ruby-macho 2.1.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4fdf0c3007545c3c9a84dacc832b803fc83edfe4aef0513eba857f14fcd2d1
-  data.tar.gz: 0dd36193221a6d9f25084b5d8dea8f17eb8165a1f304e2d0006433ade11d61b8
+  metadata.gz: cfe1d04c6c841958f4ac428e7207d89e02371fa9ca9ac3cb48e3e2a34a65dc24
+  data.tar.gz: 21dc14db70485e37ff5e430d5f8a99af6cb1c0ac14f02ae1943121fa2c482629
 SHA512:
-  metadata.gz: a07521accccc3e50119811ca36392c9ecc579dd0d8a238e8dcec5473f75325a2017a367d58212bc8fd1287e78f0b043f19546cf37eaa95c5c7f65623e7d3e015
-  data.tar.gz: 16f243d60a944e725795bb77b6c2a301e5be7939df83c70c9929f23346792f7854c9b5ad626ea2bdf301155f882f43b934e12064efdc709723a6321fc13a83d5
+  metadata.gz: d668c48f840f4423ae4bbc89d30c53e26a709491d2f8ca66bc98c637563e596d107638779bd517bf1fe89458d5f05beadf76ea60d80a44578aa0b409be61fc43
+  data.tar.gz: 84009cdfbe5c61bc84ffd8838c7fe033171ebc05af18b7748c53ced99a0e92fd7f45f1a7c0f50001c05eb253e00564b3f8dbe7735fe04df087b3fef72d2be7e6

data/README.md

@@ -13,6 +13,14 @@ The [Mach-O file format](https://en.wikipedia.org/wiki/Mach-O) is used by macOS
 and iOS (among others) as a general purpose binary format for object files,
 executables, dynamic libraries, and so forth.
 
+### Installation
+
+ruby-macho can be installed via RubyGems:
+
+```bash
+$ gem install ruby-macho
+```
+
 ### Documentation
 
 Full documentation is available on [RubyDoc](http://www.rubydoc.info/gems/ruby-macho/).
@@ -46,7 +54,6 @@ puts lc_vers.version_string # => "10.10.0"
 
 ### What needs to be done?
 
-* Documentation.
 * Unit and performance testing.
 
 Attribution:

data/lib/macho.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "open3"
+
 require_relative "macho/structure"
 require_relative "macho/view"
 require_relative "macho/headers"
@@ -12,7 +16,7 @@ require_relative "macho/tools"
 # The primary namespace for ruby-macho.
 module MachO
   # release version
-  VERSION = "2.1.0".freeze
+  VERSION = "2.5.1"
 
   # Opens the given filename as a MachOFile or FatFile, depending on its magic.
   # @param filename [String] the file being opened
@@ -25,7 +29,7 @@ module MachO
     raise ArgumentError, "#{filename}: no such file" unless File.file?(filename)
     raise TruncatedFileError unless File.stat(filename).size >= 4
 
-    magic = File.open(filename, "rb") { |f| f.read(4) }.unpack("N").first
+    magic = File.open(filename, "rb") { |f| f.read(4) }.unpack1("N")
 
     if Utils.fat_magic?(magic)
       file = FatFile.new(filename)
@@ -37,4 +41,21 @@ module MachO
 
     file
   end
+
+  # Signs the dylib using an ad-hoc identity.
+  # Necessary after making any changes to a dylib, since otherwise
+  # changing a signed file invalidates its signature.
+  # @param filename [String] the file being opened
+  # @return [void]
+  # @raise [ModificationError] if the operation fails
+  def self.codesign!(filename)
+    raise ArgumentError, "codesign binary is not available on Linux" if RUBY_PLATFORM !~ /darwin/
+    raise ArgumentError, "#{filename}: no such file" unless File.file?(filename)
+
+    _, _, status = Open3.capture3("codesign", "--sign", "-", "--force",
+                                  "--preserve-metadata=entitlements,requirements,flags,runtime",
+                                  filename)
+
+    raise CodeSigningError, "#{filename}: signing failed!" unless status.success?
+  end
 end

data/lib/macho/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MachO
   # A generic Mach-O error in execution.
   class MachOError < RuntimeError
@@ -7,6 +9,11 @@ module MachO
   class ModificationError < MachOError
   end
 
+  # Raised when codesigning fails. Certain environments
+  # may want to rescue this to treat it as non-fatal.
+  class CodeSigningError < MachOError
+  end
+
   # Raised when a Mach-O file modification fails but can be recovered when
   # operating on multiple Mach-O slices of a fat binary in non-strict mode.
   class RecoverableModificationError < ModificationError
@@ -25,10 +32,6 @@ module MachO
 
   # Raised when a file is not a Mach-O.
   class NotAMachOError < MachOError
-    # @param error [String] the error in question
-    def initialize(error)
-      super error
-    end
   end
 
   # Raised when a file is too short to be a valid Mach-O file.
@@ -41,8 +44,8 @@ module MachO
   # Raised when a file's magic bytes are not valid Mach-O magic.
   class MagicError < NotAMachOError
     # @param num [Integer] the unknown number
-    def initialize(num)
-      super "Unrecognized Mach-O magic: 0x#{"%02x" % num}"
+    def initialize(magic)
+      super "Unrecognized Mach-O magic: 0x%02<magic>x" % { :magic => magic }
     end
   end
 
@@ -71,7 +74,7 @@ module MachO
   class CPUTypeError < MachOError
     # @param cputype [Integer] the unknown CPU type
     def initialize(cputype)
-      super "Unrecognized CPU type: 0x#{"%08x" % cputype}"
+      super "Unrecognized CPU type: 0x%08<cputype>x" % { :cputype => cputype }
     end
   end
 
@@ -80,8 +83,8 @@ module MachO
     # @param cputype [Integer] the CPU type of the unknown pair
     # @param cpusubtype [Integer] the CPU sub-type of the unknown pair
     def initialize(cputype, cpusubtype)
-      super "Unrecognized CPU sub-type: 0x#{"%08x" % cpusubtype}" \
-        " (for CPU type: 0x#{"%08x" % cputype})"
+      super "Unrecognized CPU sub-type: 0x%08<cpusubtype>x" \
+        " (for CPU type: 0x%08<cputype>x" % { :cputype => cputype, :cpusubtype => cpusubtype }
     end
   end
 
@@ -89,7 +92,7 @@ module MachO
   class FiletypeError < MachOError
     # @param num [Integer] the unknown number
     def initialize(num)
-      super "Unrecognized Mach-O filetype code: 0x#{"%02x" % num}"
+      super "Unrecognized Mach-O filetype code: 0x%02<num>x" % { :num => num }
     end
   end
 
@@ -97,7 +100,7 @@ module MachO
   class LoadCommandError < MachOError
     # @param num [Integer] the unknown number
     def initialize(num)
-      super "Unrecognized Mach-O load command: 0x#{"%02x" % num}"
+      super "Unrecognized Mach-O load command: 0x%02<num>x" % { :num => num }
     end
   end
 

data/lib/macho/fat_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 
 module MachO
@@ -11,6 +13,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 +55,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)
 
@@ -62,7 +66,7 @@ module MachO
         offset += (macho.serialize.bytesize + macho_pads[macho])
       end
 
-      machos.each do |macho|
+      machos.each do |macho| # rubocop:disable Style/CombinableLoops
         bin << Utils.nullpad(macho_pads[macho])
         bin << macho.serialize
       end
@@ -72,30 +76,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 +368,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
@@ -388,16 +398,14 @@ module MachO
       errors = []
 
       machos.each_with_index do |macho, index|
-        begin
-          yield macho
-        rescue RecoverableModificationError => error
-          error.macho_slice = index
+        yield macho
+      rescue RecoverableModificationError => e
+        e.macho_slice = index
 
-          # Strict mode: Immediately re-raise. Otherwise: Retain, check later.
-          raise error if strict
+        # Strict mode: Immediately re-raise. Otherwise: Retain, check later.
+        raise e if strict
 
-          errors << error
-        end
+        errors << e
       end
 
       # Non-strict mode: Raise first error if *all* Mach-O slices failed.

data/lib/macho/headers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MachO
   # Classes and constants for parsing the headers of Mach-O binaries.
   module Headers
@@ -241,6 +243,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 +356,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,
@@ -485,7 +492,7 @@ module MachO
       # always big-endian
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "N2".freeze
+      FORMAT = "N2"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -493,6 +500,7 @@ module MachO
 
       # @api private
       def initialize(magic, nfat_arch)
+        super()
         @magic = magic
         @nfat_arch = nfat_arch
       end
@@ -536,7 +544,7 @@ module MachO
       # @note Always big endian.
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L>5".freeze
+      FORMAT = "L>5"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -544,6 +552,7 @@ module MachO
 
       # @api private
       def initialize(cputype, cpusubtype, offset, size, align)
+        super()
         @cputype = cputype
         @cpusubtype = cpusubtype & ~CPU_SUBTYPE_MASK
         @offset = offset
@@ -582,7 +591,7 @@ module MachO
       # @note Always big endian.
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L>2Q>2L>2".freeze
+      FORMAT = "L>2Q>2L>2"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -632,7 +641,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=7".freeze
+      FORMAT = "L=7"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -641,6 +650,7 @@ module MachO
       # @api private
       def initialize(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds,
                      flags)
+        super()
         @magic = magic
         @cputype = cputype
         # For now we're not interested in additional capability bits also to be
@@ -755,7 +765,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=8".freeze
+      FORMAT = "L=8"
 
       # @see MachOStructure::SIZEOF
       # @api private

data/lib/macho/load_commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MachO
   # Classes and constants for parsing load commands in Mach-O binaries.
   module LoadCommands
@@ -60,6 +62,8 @@ module MachO
       0x30 => :LC_VERSION_MIN_WATCHOS,
       0x31 => :LC_NOTE,
       0x32 => :LC_BUILD_VERSION,
+      (0x33 | LC_REQ_DYLD) => :LC_DYLD_EXPORTS_TRIE,
+      (0x34 | LC_REQ_DYLD) => :LD_DYLD_CHAINED_FIXUPS,
     }.freeze
 
     # association of symbol representations to load command constants
@@ -145,6 +149,8 @@ module MachO
       :LC_VERSION_MIN_WATCHOS => "VersionMinCommand",
       :LC_NOTE => "NoteCommand",
       :LC_BUILD_VERSION => "BuildVersionCommand",
+      :LC_DYLD_EXPORTS_TRIE => "LinkeditDataCommand",
+      :LD_DYLD_CHAINED_FIXUPS => "LinkeditDataCommand",
     }.freeze
 
     # association of segment name symbols to names
@@ -186,7 +192,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2".freeze
+      FORMAT = "L=2"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -225,6 +231,7 @@ module MachO
       # @param cmdsize [Integer] the size of the load command in bytes
       # @api private
       def initialize(view, cmd, cmdsize)
+        super()
         @view = view
         @cmd = cmd
         @cmdsize = cmdsize
@@ -365,7 +372,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2a16".freeze
+      FORMAT = "L=2a16"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -379,7 +386,7 @@ module MachO
 
       # @return [String] a string representation of the UUID
       def uuid_string
-        hexes = uuid.map { |e| "%02x" % e }
+        hexes = uuid.map { |elem| "%02<elem>x" % { :elem => elem } }
         segs = [
           hexes[0..3].join, hexes[4..5].join, hexes[6..7].join,
           hexes[8..9].join, hexes[10..15].join
@@ -429,7 +436,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2Z16L=4l=2L=2".freeze
+      FORMAT = "L=2Z16L=4l=2L=2"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -524,7 +531,7 @@ module MachO
     class SegmentCommand64 < SegmentCommand
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2Z16Q=4l=2L=2".freeze
+      FORMAT = "L=2Z16Q=4l=2L=2"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -550,7 +557,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=6".freeze
+      FORMAT = "L=6"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -601,7 +608,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=3".freeze
+      FORMAT = "L=3"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -649,7 +656,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=5".freeze
+      FORMAT = "L=5"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -679,7 +686,7 @@ module MachO
     class ThreadCommand < LoadCommand
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2".freeze
+      FORMAT = "L=2"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -717,7 +724,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=10".freeze
+      FORMAT = "L=10"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -758,7 +765,7 @@ module MachO
     class RoutinesCommand64 < RoutinesCommand
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2Q=8".freeze
+      FORMAT = "L=2Q=8"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -773,7 +780,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=3".freeze
+      FORMAT = "L=3"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -801,7 +808,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=3".freeze
+      FORMAT = "L=3"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -829,7 +836,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=3".freeze
+      FORMAT = "L=3"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -857,7 +864,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=3".freeze
+      FORMAT = "L=3"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -894,7 +901,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=6".freeze
+      FORMAT = "L=6"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -979,7 +986,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=20".freeze
+      FORMAT = "L=20"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1052,7 +1059,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=4".freeze
+      FORMAT = "L=4"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1127,7 +1134,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=3".freeze
+      FORMAT = "L=3"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1156,7 +1163,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=3".freeze
+      FORMAT = "L=3"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1191,7 +1198,8 @@ module MachO
     # A load command representing the offsets and sizes of a blob of data in
     # the __LINKEDIT segment. Corresponds to LC_CODE_SIGNATURE,
     # LC_SEGMENT_SPLIT_INFO, LC_FUNCTION_STARTS, LC_DATA_IN_CODE,
-    # LC_DYLIB_CODE_SIGN_DRS, and LC_LINKER_OPTIMIZATION_HINT.
+    # LC_DYLIB_CODE_SIGN_DRS, LC_LINKER_OPTIMIZATION_HINT, LC_DYLD_EXPORTS_TRIE,
+    # or LC_DYLD_CHAINED_FIXUPS.
     class LinkeditDataCommand < LoadCommand
       # @return [Integer] offset to the data in the __LINKEDIT segment
       attr_reader :dataoff
@@ -1201,7 +1209,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=4".freeze
+      FORMAT = "L=4"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1237,7 +1245,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=5".freeze
+      FORMAT = "L=5"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1269,7 +1277,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=6".freeze
+      FORMAT = "L=6"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1301,7 +1309,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=4".freeze
+      FORMAT = "L=4"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1317,7 +1325,7 @@ module MachO
       # A string representation of the binary's minimum OS version.
       # @return [String] a string representing the minimum OS version.
       def version_string
-        binary = "%032b" % version
+        binary = "%032<version>b" % { :version => version }
         segs = [
           binary[0..15], binary[16..23], binary[24..31]
         ].map { |s| s.to_i(2) }
@@ -1328,7 +1336,7 @@ module MachO
       # A string representation of the binary's SDK version.
       # @return [String] a string representing the SDK version.
       def sdk_string
-        binary = "%032b" % sdk
+        binary = "%032<sdk>b" % { :sdk => sdk }
         segs = [
           binary[0..15], binary[16..23], binary[24..31]
         ].map { |s| s.to_i(2) }
@@ -1365,7 +1373,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=6".freeze
+      FORMAT = "L=6"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1383,7 +1391,7 @@ module MachO
       # A string representation of the binary's minimum OS version.
       # @return [String] a string representing the minimum OS version.
       def minos_string
-        binary = "%032b" % minos
+        binary = "%032<minos>b" % { :minos => minos }
         segs = [
           binary[0..15], binary[16..23], binary[24..31]
         ].map { |s| s.to_i(2) }
@@ -1394,7 +1402,7 @@ module MachO
       # A string representation of the binary's SDK version.
       # @return [String] a string representing the SDK version.
       def sdk_string
-        binary = "%032b" % sdk
+        binary = "%032<sdk>b" % { :sdk => sdk }
         segs = [
           binary[0..15], binary[16..23], binary[24..31]
         ].map { |s| s.to_i(2) }
@@ -1494,7 +1502,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=12".freeze
+      FORMAT = "L=12"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1542,7 +1550,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=3".freeze
+      FORMAT = "L=3"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1572,7 +1580,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2Q=2".freeze
+      FORMAT = "L=2Q=2"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1602,7 +1610,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2Q=1".freeze
+      FORMAT = "L=2Q=1"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1617,7 +1625,7 @@ module MachO
       # A string representation of the sources used to build the binary.
       # @return [String] a string representation of the version
       def version_string
-        binary = "%064b" % version
+        binary = "%064<version>b" % { :version => version }
         segs = [
           binary[0..23], binary[24..33], binary[34..43], binary[44..53],
           binary[54..63]
@@ -1646,7 +1654,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=4".freeze
+      FORMAT = "L=4"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1674,7 +1682,7 @@ module MachO
     class IdentCommand < LoadCommand
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2".freeze
+      FORMAT = "L=2"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1692,7 +1700,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=4".freeze
+      FORMAT = "L=4"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1727,7 +1735,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=5".freeze
+      FORMAT = "L=5"
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -1764,7 +1772,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2Z16Q=2".freeze
+      FORMAT = "L=2Z16Q=2"
 
       # @see MachOStructure::SIZEOF
       # @api private

data/lib/macho/macho_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 
 module MachO
@@ -9,10 +11,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 +32,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 +157,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 +186,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)
@@ -411,11 +418,8 @@ module MachO
       rpath_cmds = command(:LC_RPATH).select { |r| r.path.to_s == path }
       raise RpathUnknownError, path if rpath_cmds.empty?
 
-      # delete the commands in reverse order, offset descending. this
-      # allows us to defer (expensive) field population until the very end
-      rpath_cmds.reverse_each { |cmd| delete_command(cmd, :repopulate => false) }
-
-      populate_fields
+      # delete the commands in reverse order, offset descending.
+      rpath_cmds.reverse_each { |cmd| delete_command(cmd) }
     end
 
     # Write all Mach-O data to the given filename.
@@ -471,7 +475,7 @@ module MachO
     # @raise [FatBinaryError] if the magic is for a Fat file
     # @api private
     def populate_and_check_magic
-      magic = @raw_data[0..3].unpack("N").first
+      magic = @raw_data[0..3].unpack1("N")
 
       raise MagicError, magic unless Utils.magic?(magic)
       raise FatBinaryError if Utils.fat_magic?(magic)
@@ -511,19 +515,25 @@ 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 = []
 
       header.ncmds.times do
         fmt = Utils.specialize_format("L=", endianness)
-        cmd = @raw_data.slice(offset, 4).unpack(fmt).first
+        cmd = @raw_data.slice(offset, 4).unpack1(fmt)
         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)
 

data/lib/macho/sections.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MachO
   # Classes and constants for parsing sections in Mach-O binaries.
   module Sections
@@ -108,7 +110,7 @@ module MachO
       attr_reader :reserved2
 
       # @see MachOStructure::FORMAT
-      FORMAT = "Z16Z16L=9".freeze
+      FORMAT = "Z16Z16L=9"
 
       # @see MachOStructure::SIZEOF
       SIZEOF = 68
@@ -116,6 +118,7 @@ module MachO
       # @api private
       def initialize(sectname, segname, addr, size, offset, align, reloff,
                      nreloc, flags, reserved1, reserved2)
+        super()
         @sectname = sectname
         @segname = segname
         @addr = addr
@@ -180,7 +183,7 @@ module MachO
       attr_reader :reserved3
 
       # @see MachOStructure::FORMAT
-      FORMAT = "Z16Z16Q=2L=8".freeze
+      FORMAT = "Z16Z16Q=2L=8"
 
       # @see MachOStructure::SIZEOF
       SIZEOF = 80

data/lib/macho/structure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MachO
   # A general purpose pseudo-structure.
   # @abstract
@@ -5,7 +7,7 @@ module MachO
     # The String#unpack format of the data structure.
     # @return [String] the unpacking format
     # @api private
-    FORMAT = "".freeze
+    FORMAT = ""
 
     # The size of the data structure, in bytes.
     # @return [Integer] the size, in bytes

data/lib/macho/tools.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MachO
   # A collection of convenient methods for common operations on Mach-O and Fat
   # binaries.

data/lib/macho/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MachO
   # A collection of utility functions used throughout ruby-macho.
   module Utils
@@ -51,7 +53,7 @@ module MachO
     def self.pack_strings(fixed_offset, alignment, strings = {})
       offsets = {}
       next_offset = fixed_offset
-      payload = ""
+      payload = +""
 
       strings.each do |key, string|
         offsets[key] = next_offset
@@ -61,7 +63,7 @@ module MachO
       end
 
       payload << Utils.nullpad(padding_for(fixed_offset + payload.bytesize, alignment))
-      [payload, offsets]
+      [payload.freeze, offsets]
     end
 
     # Compares the given number to valid Mach-O magic numbers.

data/lib/macho/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MachO
   # A representation of some unspecified Mach-O data.
   class MachOView

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-macho
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.5.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2021-05-15 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.5'
 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.3
 signing_key: 
 specification_version: 4
 summary: ruby-macho - Mach-O file analyzer.