ruby-macho 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c4525869d67df12f84b98120b7a0e28cd2e554b
-  data.tar.gz: 007fa710b4d119fe5bb477d4dea2c51664ddbb8d
+  metadata.gz: 633935fc4cb74f62b33362d5ecb5f4db5b6d4cbf
+  data.tar.gz: f69c9cedb248620ce5e8477f5f3ee02d9cf9a483
 SHA512:
-  metadata.gz: c90ef356d11b1c19b28703ef5a45ef2f1f999a7836ec126b4106a17dcc39630b825a8cd860cbd70c6c31225182c348eb5d1b2f0579fe9ecc072ce39a0ffc0c7c
-  data.tar.gz: a8bb43dd63755f1b1db1f1e3bfc23120d88f41020aa021dea91db9c8e2c7a2e14d7c5182bf2bb315c09236decba982202461a57f8b670ee78d57e1a40b04b874
+  metadata.gz: 957d16360147749264145ac81312e28e8fdd612d24802659642416f8bb2ad2a2e0d3998bc8be15d2adb24c41ef00ba8ec9be16e4c4f28fc6801cf07f358f9128
+  data.tar.gz: 327c34832cc7233b81023f49fbbb6ae34fbece07ea6cdb0c4e7f9b89237e5780d1acfd359a073c5638f3fd81eb23895d540caca07cd91c1706ca10cded96c6b3

data/README.md

@@ -51,7 +51,7 @@ puts lc_vers.version_string # => "10.10.0"
 Attribution:
 
 * Constants were taken from Apple, Inc's
-[`loader.h` in `cctools/include/mach-o`](http://www.opensource.apple.com/source/cctools/cctools-870/include/mach-o/loader.h).
+[`loader.h` in `cctools/include/mach-o`](https://www.opensource.apple.com/source/cctools/cctools-870/include/mach-o/loader.h).
 (Apple Public Source License 2.0).
 
 ### License

data/lib/macho.rb

@@ -12,15 +12,15 @@ require "#{File.dirname(__FILE__)}/macho/tools"
 # The primary namespace for ruby-macho.
 module MachO
   # release version
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 
   # Opens the given filename as a MachOFile or FatFile, depending on its magic.
   # @param filename [String] the file being opened
-  # @return [MachO::MachOFile] if the file is a Mach-O
-  # @return [MachO::FatFile] if the file is a Fat file
+  # @return [MachOFile] if the file is a Mach-O
+  # @return [FatFile] if the file is a Fat file
   # @raise [ArgumentError] if the given file does not exist
-  # @raise [MachO::TruncatedFileError] if the file is too small to have a valid header
-  # @raise [MachO::MagicError] if the file's magic is not valid Mach-O magic
+  # @raise [TruncatedFileError] if the file is too small to have a valid header
+  # @raise [MagicError] if the file's magic is not valid Mach-O magic
   def self.open(filename)
     raise ArgumentError, "#{filename}: no such file" unless File.file?(filename)
     raise TruncatedFileError unless File.stat(filename).size >= 4

data/lib/macho/exceptions.rb

@@ -80,7 +80,8 @@ module MachO
     # @param cputype [Fixnum] the CPU type of the unknown pair
     # @param cpusubtype [Fixnum] 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#{"%08x" % cpusubtype}" \
+        " (for CPU type: 0x#{"%08x" % cputype})"
     end
   end
 
@@ -108,13 +109,15 @@ module MachO
     end
   end
 
-  # Raised when the number of arguments used to create a load command manually is wrong.
+  # Raised when the number of arguments used to create a load command manually
+  # is wrong.
   class LoadCommandCreationArityError < MachOError
     # @param cmd_sym [Symbol] the load command's symbol
     # @param expected_arity [Fixnum] the number of arguments expected
     # @param actual_arity [Fixnum] the number of arguments received
     def initialize(cmd_sym, expected_arity, actual_arity)
-      super "Expected #{expected_arity} arguments for #{cmd_sym} creation, got #{actual_arity}"
+      super "Expected #{expected_arity} arguments for #{cmd_sym} creation," \
+        " got #{actual_arity}"
     end
   end
 
@@ -130,7 +133,8 @@ module MachO
   class LCStrMalformedError < MachOError
     # @param lc [MachO::LoadCommand] the load command containing the string
     def initialize(lc)
-      super "Load command #{lc.type} at offset #{lc.view.offset} contains a malformed string"
+      super "Load command #{lc.type} at offset #{lc.view.offset} contains a" \
+        " malformed string"
     end
   end
 

data/lib/macho/fat_file.rb

@@ -1,24 +1,50 @@
+require "forwardable"
+
 module MachO
   # Represents a "Fat" file, which contains a header, a listing of available
   # architectures, and one or more Mach-O binaries.
   # @see https://en.wikipedia.org/wiki/Mach-O#Multi-architecture_binaries
-  # @see MachO::MachOFile
+  # @see MachOFile
   class FatFile
+    extend Forwardable
+
     # @return [String] the filename loaded from, or nil if loaded from a binary string
     attr_accessor :filename
 
-    # @return [MachO::Headers::FatHeader] the file's header
+    # @return [Headers::FatHeader] the file's header
     attr_reader :header
 
-    # @return [Array<MachO::Headers::FatArch>] an array of fat architectures
+    # @return [Array<Headers::FatArch>] an array of fat architectures
     attr_reader :fat_archs
 
-    # @return [Array<MachO::MachOFile>] an array of Mach-O binaries
+    # @return [Array<MachOFile>] an array of Mach-O binaries
     attr_reader :machos
 
+    # Creates a new FatFile from the given (single-arch) Mach-Os
+    # @param machos [Array<MachOFile>] the machos to combine
+    # @return [FatFile] a new FatFile containing the give machos
+    def self.new_from_machos(*machos)
+      header = Headers::FatHeader.new(Headers::FAT_MAGIC, machos.size)
+      offset = Headers::FatHeader.bytesize + (machos.size * Headers::FatArch.bytesize)
+      fat_archs = []
+      machos.each do |macho|
+        fat_archs << Headers::FatArch.new(macho.header.cputype,
+                                          macho.header.cpusubtype,
+                                          offset, macho.serialize.bytesize,
+                                          macho.alignment)
+        offset += macho.serialize.bytesize
+      end
+
+      bin = header.serialize
+      bin << fat_archs.map(&:serialize).join
+      bin << machos.map(&:serialize).join
+
+      new_from_bin(bin)
+    end
+
     # Creates a new FatFile instance from a binary string.
     # @param bin [String] a binary string containing raw Mach-O data
-    # @return [MachO::FatFile] a new FatFile
+    # @return [FatFile] a new FatFile
     def self.new_from_bin(bin)
       instance = allocate
       instance.initialize_from_bin(bin)
@@ -38,7 +64,7 @@ module MachO
     end
 
     # Initializes a new FatFile instance from a binary string.
-    # @see MachO::FatFile.new_from_bin
+    # @see new_from_bin
     # @api private
     def initialize_from_bin(bin)
       @filename = nil
@@ -52,72 +78,43 @@ module MachO
       @raw_data
     end
 
-    # @return [Boolean] true if the file is of type `MH_OBJECT`, false otherwise
-    def object?
-      machos.first.object?
-    end
-
-    # @return [Boolean] true if the file is of type `MH_EXECUTE`, false otherwise
-    def executable?
-      machos.first.executable?
-    end
-
-    # @return [Boolean] true if the file is of type `MH_FVMLIB`, false otherwise
-    def fvmlib?
-      machos.first.fvmlib?
-    end
-
-    # @return [Boolean] true if the file is of type `MH_CORE`, false otherwise
-    def core?
-      machos.first.core?
-    end
-
-    # @return [Boolean] true if the file is of type `MH_PRELOAD`, false otherwise
-    def preload?
-      machos.first.preload?
-    end
-
-    # @return [Boolean] true if the file is of type `MH_DYLIB`, false otherwise
-    def dylib?
-      machos.first.dylib?
-    end
-
-    # @return [Boolean] true if the file is of type `MH_DYLINKER`, false otherwise
-    def dylinker?
-      machos.first.dylinker?
-    end
-
-    # @return [Boolean] true if the file is of type `MH_BUNDLE`, false otherwise
-    def bundle?
-      machos.first.bundle?
-    end
-
-    # @return [Boolean] true if the file is of type `MH_DSYM`, false otherwise
-    def dsym?
-      machos.first.dsym?
-    end
-
-    # @return [Boolean] true if the file is of type `MH_KEXT_BUNDLE`, false otherwise
-    def kext?
-      machos.first.kext?
-    end
-
-    # @return [Fixnum] the file's magic number
-    def magic
-      header.magic
-    end
+    # @!method object?
+    #  @return (see MachO::MachOFile#object?)
+    # @!method executable?
+    #  @return (see MachO::MachOFile#executable?)
+    # @!method fvmlib?
+    #  @return (see MachO::MachOFile#fvmlib?)
+    # @!method core?
+    #  @return (see MachO::MachOFile#core?)
+    # @!method preload?
+    #  @return (see MachO::MachOFile#preload?)
+    # @!method dylib?
+    #  @return (see MachO::MachOFile#dylib?)
+    # @!method dylinker?
+    #  @return (see MachO::MachOFile#dylinker?)
+    # @!method bundle?
+    #  @return (see MachO::MachOFile#bundle?)
+    # @!method dsym?
+    #  @return (see MachO::MachOFile#dsym?)
+    # @!method kext?
+    #  @return (see MachO::MachOFile#kext?)
+    # @!method filetype
+    #  @return (see MachO::MachOFile#filetype)
+    # @!method dylib_id
+    #  @return (see MachO::MachOFile#dylib_id)
+    def_delegators :canonical_macho, :object?, :executable?, :fvmlib?,
+                   :core?, :preload?, :dylib?, :dylinker?, :bundle?,
+                   :dsym?, :kext?, :filetype, :dylib_id
+
+    # @!method magic
+    #  @return (see MachO::Headers::FatHeader#magic)
+    def_delegators :header, :magic
 
     # @return [String] a string representation of the file's magic number
     def magic_string
       Headers::MH_MAGICS[magic]
     end
 
-    # The file's type. Assumed to be the same for every Mach-O within.
-    # @return [Symbol] the filetype
-    def filetype
-      machos.first.filetype
-    end
-
     # Populate the instance's fields with the raw Fat Mach-O data.
     # @return [void]
     # @note This method is public, but should (almost) never need to be called.
@@ -128,21 +125,13 @@ module MachO
     end
 
     # All load commands responsible for loading dylibs in the file's Mach-O's.
-    # @return [Array<MachO::LoadCommands::DylibCommand>] an array of DylibCommands
+    # @return [Array<LoadCommands::DylibCommand>] an array of DylibCommands
     def dylib_load_commands
       machos.map(&:dylib_load_commands).flatten
     end
 
-    # The file's dylib ID. If the file is not a dylib, returns `nil`.
-    # @example
-    #  file.dylib_id # => 'libBar.dylib'
-    # @return [String, nil] the file's dylib ID
-    # @see MachO::MachOFile#linked_dylibs
-    def dylib_id
-      machos.first.dylib_id
-    end
-
-    # Changes the file's dylib ID to `new_id`. If the file is not a dylib, does nothing.
+    # Changes the file's dylib ID to `new_id`. If the file is not a dylib,
+    #  does nothing.
     # @example
     #  file.change_dylib_id('libFoo.dylib')
     # @param new_id [String] the new dylib ID
@@ -151,7 +140,7 @@ module MachO
     #  if false, fail only if all slices fail.
     # @return [void]
     # @raise [ArgumentError] if `new_id` is not a String
-    # @see MachO::MachOFile#linked_dylibs
+    # @see MachOFile#linked_dylibs
     def change_dylib_id(new_id, options = {})
       raise ArgumentError, "argument must be a String" unless new_id.is_a?(String)
       return unless machos.all?(&:dylib?)
@@ -167,7 +156,7 @@ module MachO
 
     # All shared libraries linked to the file's Mach-Os.
     # @return [Array<String>] an array of all shared libraries
-    # @see MachO::MachOFile#linked_dylibs
+    # @see MachOFile#linked_dylibs
     def linked_dylibs
       # Individual architectures in a fat binary can link to different subsets
       # of libraries, but at this point we want to have the full picture, i.e.
@@ -175,8 +164,9 @@ module MachO
       machos.map(&:linked_dylibs).flatten.uniq
     end
 
-    # Changes all dependent shared library install names from `old_name` to `new_name`.
-    # In a fat file, this changes install names in all internal Mach-Os.
+    # Changes all dependent shared library install names from `old_name` to
+    # `new_name`. In a fat file, this changes install names in all internal
+    # Mach-Os.
     # @example
     #  file.change_install_name('/usr/lib/libFoo.dylib', '/usr/lib/libBar.dylib')
     # @param old_name [String] the shared library name being changed
@@ -185,7 +175,7 @@ module MachO
     # @option options [Boolean] :strict (true) if true, fail if one slice fails.
     #  if false, fail only if all slices fail.
     # @return [void]
-    # @see MachO::MachOFile#change_install_name
+    # @see MachOFile#change_install_name
     def change_install_name(old_name, new_name, options = {})
       each_macho(options) do |macho|
         macho.change_install_name(old_name, new_name, options)
@@ -198,7 +188,7 @@ module MachO
 
     # All runtime paths associated with the file's Mach-Os.
     # @return [Array<String>] an array of all runtime paths
-    # @see MachO::MachOFile#rpaths
+    # @see MachOFile#rpaths
     def rpaths
       # Can individual architectures have different runtime paths?
       machos.map(&:rpaths).flatten.uniq
@@ -211,7 +201,7 @@ module MachO
     # @option options [Boolean] :strict (true) if true, fail if one slice fails.
     #  if false, fail only if all slices fail.
     # @return [void]
-    # @see MachO::MachOFile#change_rpath
+    # @see MachOFile#change_rpath
     def change_rpath(old_path, new_path, options = {})
       each_macho(options) do |macho|
         macho.change_rpath(old_path, new_path, options)
@@ -226,7 +216,7 @@ module MachO
     # @option options [Boolean] :strict (true) if true, fail if one slice fails.
     #  if false, fail only if all slices fail.
     # @return [void]
-    # @see MachO::MachOFile#add_rpath
+    # @see MachOFile#add_rpath
     def add_rpath(path, options = {})
       each_macho(options) do |macho|
         macho.add_rpath(path, options)
@@ -241,7 +231,7 @@ module MachO
     # @option options [Boolean] :strict (true) if true, fail if one slice fails.
     #  if false, fail only if all slices fail.
     # @return void
-    # @see MachO::MachOFile#delete_rpath
+    # @see MachOFile#delete_rpath
     def delete_rpath(path, options = {})
       each_macho(options) do |macho|
         macho.delete_rpath(path, options)
@@ -254,20 +244,21 @@ module MachO
     # @example
     #  file.extract(:i386) # => MachO::MachOFile
     # @param cputype [Symbol] the CPU type of the Mach-O being extracted
-    # @return [MachO::MachOFile, nil] the extracted Mach-O or nil if no Mach-O has the given CPU type
+    # @return [MachOFile, nil] the extracted Mach-O or nil if no Mach-O has the given CPU type
     def extract(cputype)
       machos.select { |macho| macho.cputype == cputype }.first
     end
 
     # Write all (fat) data to the given filename.
     # @param filename [String] the file to write to
+    # @return [void]
     def write(filename)
       File.open(filename, "wb") { |f| f.write(@raw_data) }
     end
 
     # Write all (fat) data to the file used to initialize the instance.
     # @return [void]
-    # @raise [MachO::MachOError] if the instance was initialized without a file
+    # @raise [MachOError] if the instance was initialized without a file
     # @note Overwrites all data in the file!
     def write!
       if filename.nil?
@@ -280,11 +271,12 @@ module MachO
     private
 
     # Obtain the fat header from raw file data.
-    # @return [MachO::Headers::FatHeader] the fat header
-    # @raise [MachO::TruncatedFileError] if the file is too small to have a valid header
-    # @raise [MachO::MagicError] if the magic is not valid Mach-O magic
-    # @raise [MachO::MachOBinaryError] if the magic is for a non-fat Mach-O file
-    # @raise [MachO::JavaClassFileError] if the file is a Java classfile
+    # @return [Headers::FatHeader] the fat header
+    # @raise [TruncatedFileError] if the file is too small to have a
+    #  valid header
+    # @raise [MagicError] if the magic is not valid Mach-O magic
+    # @raise [MachOBinaryError] if the magic is for a non-fat Mach-O file
+    # @raise [JavaClassFileError] if the file is a Java classfile
     # @api private
     def populate_fat_header
       # the smallest fat Mach-O header is 8 bytes
@@ -308,7 +300,7 @@ module MachO
     end
 
     # Obtain an array of fat architectures from raw file data.
-    # @return [Array<MachO::Headers::FatArch>] an array of fat architectures
+    # @return [Array<Headers::FatArch>] an array of fat architectures
     # @api private
     def populate_fat_archs
       archs = []
@@ -323,7 +315,7 @@ module MachO
     end
 
     # Obtain an array of Mach-O blobs from raw file data.
-    # @return [Array<MachO::MachOFile>] an array of Mach-Os
+    # @return [Array<MachOFile>] an array of Mach-Os
     # @api private
     def populate_machos
       machos = []
@@ -351,7 +343,7 @@ module MachO
     # @option options [Boolean] :strict (true) whether or not to fail loudly
     #  with an exception if at least one Mach-O raises an exception. If false,
     #  only raises an exception if *all* Mach-Os raise exceptions.
-    # @raise [MachO::RecoverableModificationError] under the conditions of
+    # @raise [RecoverableModificationError] under the conditions of
     #  the `:strict` option above.
     # @api private
     def each_macho(options = {})
@@ -373,5 +365,13 @@ module MachO
       # Non-strict mode: Raise first error if *all* Mach-O slices failed.
       raise errors.first if errors.size == machos.size
     end
+
+    # Return a single-arch Mach-O that represents this fat Mach-O for purposes
+    #  of delegation.
+    # @return [MachOFile] the Mach-O file
+    # @api private
+    def canonical_macho
+      machos.first
+    end
   end
 end

data/lib/macho/headers.rb

@@ -470,6 +470,11 @@ module MachO
         @magic = magic
         @nfat_arch = nfat_arch
       end
+
+      # @return [String] the serialized fields of the fat header
+      def serialize
+        [magic, nfat_arch].pack(FORMAT)
+      end
     end
 
     # Fat binary header architecture structure. A Fat binary has one or more of
@@ -508,6 +513,11 @@ module MachO
         @size = size
         @align = align
       end
+
+      # @return [String] the serialized fields of the fat arch
+      def serialize
+        [cputype, cpusubtype, offset, size, align].pack(FORMAT)
+      end
     end
 
     # 32-bit Mach-O file header structure
@@ -564,6 +574,71 @@ module MachO
         return false if flag.nil?
         flags & flag == flag
       end
+
+      # @return [Boolean] whether or not the file is of type `MH_OBJECT`
+      def object?
+        filetype == Headers::MH_OBJECT
+      end
+
+      # @return [Boolean] whether or not the file is of type `MH_EXECUTE`
+      def executable?
+        filetype == Headers::MH_EXECUTE
+      end
+
+      # @return [Boolean] whether or not the file is of type `MH_FVMLIB`
+      def fvmlib?
+        filetype == Headers::MH_FVMLIB
+      end
+
+      # @return [Boolean] whether or not the file is of type `MH_CORE`
+      def core?
+        filetype == Headers::MH_CORE
+      end
+
+      # @return [Boolean] whether or not the file is of type `MH_PRELOAD`
+      def preload?
+        filetype == Headers::MH_PRELOAD
+      end
+
+      # @return [Boolean] whether or not the file is of type `MH_DYLIB`
+      def dylib?
+        filetype == Headers::MH_DYLIB
+      end
+
+      # @return [Boolean] whether or not the file is of type `MH_DYLINKER`
+      def dylinker?
+        filetype == Headers::MH_DYLINKER
+      end
+
+      # @return [Boolean] whether or not the file is of type `MH_BUNDLE`
+      def bundle?
+        filetype == Headers::MH_BUNDLE
+      end
+
+      # @return [Boolean] whether or not the file is of type `MH_DSYM`
+      def dsym?
+        filetype == Headers::MH_DSYM
+      end
+
+      # @return [Boolean] whether or not the file is of type `MH_KEXT_BUNDLE`
+      def kext?
+        filetype == Headers::MH_KEXT_BUNDLE
+      end
+
+      # @return [Boolean] true if the Mach-O has 32-bit magic, false otherwise
+      def magic32?
+        Utils.magic32?(magic)
+      end
+
+      # @return [Boolean] true if the Mach-O has 64-bit magic, false otherwise
+      def magic64?
+        Utils.magic64?(magic)
+      end
+
+      # @return [Fixnum] the file's internal alignment
+      def alignment
+        magic32? ? 4 : 8
+      end
     end
 
     # 64-bit Mach-O file header structure