ruby-macho 4.1.0 → 6.0.0

data/lib/macho/macho_file.rb

@@ -60,7 +60,12 @@ module MachO
 
       @filename = filename
       @options = opts
-      @raw_data = File.binread(@filename)
+      File.open(@filename, "rb") do |file|
+        @raw_data = file.read(Headers::MachHeader.bytesize)
+        @raw_data ||= ""
+        populate_mach_header if !opts.fetch(:decompress, false) || !Utils.compressed_magic?(@raw_data.unpack1("N"))
+        @raw_data << file.read.to_s
+      end
       populate_fields
     end
 
@@ -147,7 +152,7 @@ module MachO
     # @return [Array<LoadCommands::LoadCommand>] an array of load commands
     #  corresponding to `name`
     def command(name)
-      load_commands.select { |lc| lc.type == name.to_sym }
+      @load_commands_by_type.fetch(name.to_sym, []).dup
     end
 
     alias [] command
@@ -245,6 +250,7 @@ module MachO
     #  The exception to this rule is when methods like {#add_command} and
     #  {#delete_command} have been called with `repopulate = false`.
     def populate_fields
+      clear_memoization_cache
       @header = populate_mach_header
       @load_commands = populate_load_commands
     end
@@ -252,7 +258,8 @@ module MachO
     # All load commands responsible for loading dylibs.
     # @return [Array<LoadCommands::DylibCommand>] an array of DylibCommands
     def dylib_load_commands
-      load_commands.select { |lc| LoadCommands::DYLIB_LOAD_COMMANDS.include?(lc.type) }
+      @dylib_load_commands ||= load_commands.select { |lc| LoadCommands::DYLIB_LOAD_COMMANDS.include?(lc.type) }
+      @dylib_load_commands.dup
     end
 
     # All segment load commands in the Mach-O.
@@ -271,26 +278,7 @@ module MachO
     # @note This is **not** the same as {#alignment}!
     # @note See `get_align` and `get_align_64` in `cctools/misc/lipo.c`
     def segment_alignment
-      # special cases: 12 for x86/64/PPC/PP64, 14 for ARM/ARM64
-      return 12 if %i[i386 x86_64 ppc ppc64].include?(cputype)
-      return 14 if %i[arm arm64].include?(cputype)
-
-      cur_align = Sections::MAX_SECT_ALIGN
-
-      segments.each do |segment|
-        if filetype == :object
-          # start with the smallest alignment, and work our way up
-          align = magic32? ? 2 : 3
-          segment.sections.each do |section|
-            align = section.align unless section.align <= align
-          end
-        else
-          align = segment.guess_align
-        end
-        cur_align = align if align < cur_align
-      end
-
-      cur_align
+      @segment_alignment ||= calculate_segment_alignment
     end
 
     # The Mach-O's dylib ID, or `nil` if not a dylib.
@@ -338,7 +326,8 @@ module MachO
       # library, but at this point we're really only interested in a list of
       # unique libraries this Mach-O file links to, thus: `uniq`. (This is also
       # for consistency with `FatFile` that merges this list across all archs.)
-      dylib_load_commands.map(&:name).map(&:to_s).uniq
+      @linked_dylibs ||= dylib_load_commands.map { |lc| lc.name.to_s }.uniq
+      @linked_dylibs.dup
     end
 
     # Changes the shared library `old_name` to `new_name`
@@ -368,7 +357,8 @@ module MachO
     # All runtime paths searched by the dynamic linker for the Mach-O.
     # @return [Array<String>] an array of all runtime paths
     def rpaths
-      command(:LC_RPATH).map(&:path).map(&:to_s)
+      @rpaths ||= command(:LC_RPATH).map { |lc| lc.path.to_s }
+      @rpaths.dup
     end
 
     # Changes the runtime path `old_path` to `new_path`
@@ -448,6 +438,13 @@ module MachO
       rpath_cmds.reverse_each { |cmd| delete_command(cmd) }
     end
 
+    # Replaces the embedded signature with a pure-Ruby ad-hoc signature.
+    # @param identifier [String, nil] the signing identifier
+    # @return [void]
+    def codesign!(identifier: nil)
+      CodeSigning::AdhocSigner.new(self, identifier || CodeSigning.identifier(self, filename)).sign!
+    end
+
     # Write all Mach-O data to the given filename.
     # @param filename [String] the file to write to
     # @return [void]
@@ -475,6 +472,17 @@ module MachO
 
     private
 
+    # Clears all memoized values. Called when the file is repopulated.
+    # @return [void]
+    # @api private
+    def clear_memoization_cache
+      @linked_dylibs = nil
+      @rpaths = nil
+      @dylib_load_commands = nil
+      @load_commands_by_type = nil
+      @segment_alignment = nil
+    end
+
     # The file's Mach-O header structure.
     # @return [Headers::MachHeader] if the Mach-O is 32-bit
     # @return [Headers::MachHeader64] if the Mach-O is 64-bit
@@ -583,16 +591,27 @@ module MachO
 
     # All load commands in the file.
     # @return [Array<LoadCommands::LoadCommand>] an array of load commands
+    # @raise [TruncatedFileError] if the declared load command data is incomplete
     # @raise [LoadCommandError] if an unknown load command is encountered
+    # @raise [LoadCommandSizeError] if a load command's size is invalid
     # @api private
     def populate_load_commands
       permissive = options.fetch(:permissive, false)
       offset = header.class.bytesize
+      load_commands_end = offset + sizeofcmds
+      raise TruncatedFileError if load_commands_end > @raw_data.bytesize
+
       load_commands = []
+      @load_commands_by_type = Hash.new { |h, k| h[k] = [] }
 
       header.ncmds.times do
+        raise TruncatedFileError if offset + LoadCommands::LoadCommand.bytesize > load_commands_end
+
         fmt = Utils.specialize_format("L=", endianness)
         cmd = @raw_data.slice(offset, 4).unpack1(fmt)
+        cmdsize = @raw_data.slice(offset + 4, 4).unpack1(fmt)
+        raise LoadCommandSizeError, cmdsize if cmdsize % 4 != 0 || offset + cmdsize > load_commands_end
+
         cmd_sym = LoadCommands::LOAD_COMMANDS[cmd]
 
         raise LoadCommandError, cmd unless cmd_sym || permissive
@@ -605,16 +624,45 @@ module MachO
           LoadCommands::LoadCommand
         end
 
+        raise LoadCommandSizeError, cmdsize if cmdsize < klass.bytesize
+
         view = MachOView.new(self, @raw_data, endianness, offset)
         command = klass.new_from_bin(view)
 
         load_commands << command
+        @load_commands_by_type[command.type] << command
         offset += command.cmdsize
       end
 
       load_commands
     end
 
+    # Calculate the segment alignment for the Mach-O. Guesses conservatively.
+    # @return [Integer] the alignment, as a power of 2
+    # @api private
+    def calculate_segment_alignment
+      # special cases: 12 for x86/64/PPC/PP64, 14 for ARM/ARM64
+      return 12 if %i[i386 x86_64 ppc ppc64].include?(cputype)
+      return 14 if %i[arm arm64].include?(cputype)
+
+      cur_align = Sections::MAX_SECT_ALIGN
+
+      segments.each do |segment|
+        if filetype == :object
+          # start with the smallest alignment, and work our way up
+          align = magic32? ? 2 : 3
+          segment.sections.each do |section|
+            align = section.align unless section.align <= align
+          end
+        else
+          align = segment.guess_align
+        end
+        cur_align = align if align < cur_align
+      end
+
+      cur_align
+    end
+
     # The low file offset (offset to first section data).
     # @return [Integer] the offset
     # @api private
@@ -622,6 +670,9 @@ module MachO
       offset = @raw_data.size
 
       segments.each do |seg|
+        offset = seg.fileoff if seg.nsects.zero? && seg.fileoff.positive? &&
+                                seg.filesize.positive? && seg.fileoff < offset
+
         seg.sections.each do |sect|
           next if sect.empty?
           next if sect.type?(:S_ZEROFILL)

data/lib/macho/structure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module MachO
-  # A general purpose pseudo-structure. Described in detail in docs/machostructure-dsl.md.
+  # A general purpose pseudo-structure. Described in detail in machostructure-dsl-docs.md.
   # @abstract
   class MachOStructure
     # Constants used for parsing MachOStructure fields

data/lib/macho.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require "open3"
-
 require_relative "macho/utils"
 require_relative "macho/structure"
 require_relative "macho/view"
 require_relative "macho/headers"
+require_relative "macho/code_signing"
 require_relative "macho/load_commands"
 require_relative "macho/sections"
 require_relative "macho/macho_file"
@@ -16,7 +15,7 @@ require_relative "macho/tools"
 # The primary namespace for ruby-macho.
 module MachO
   # release version
-  VERSION = "4.1.0"
+  VERSION = "6.0.0"
 
   # Opens the given filename as a MachOFile or FatFile, depending on its magic.
   # @param filename [String] the file being opened
@@ -42,20 +41,20 @@ 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.
+  # Signs a thin or fat Mach-O using an ad-hoc identity.
+  # Necessary after changing signed Mach-O data because the signature covers
+  # the header, load commands and all bytes preceding the signature.
   # @param filename [String] the file being opened
   # @return [void]
-  # @raise [ModificationError] if the operation fails
+  # @raise [CodeSigningError] 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?
+    file = MachO.open(filename)
+    file.codesign!
+    file.write!
+    nil
+  rescue MachOError => e
+    raise CodeSigningError, "#{filename}: signing failed: #{e.message}"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-macho
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - William Woodruff
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A library for viewing and manipulating Mach-O files in Ruby.
 email: william@yossarian.net
@@ -20,6 +19,7 @@ files:
 - LICENSE
 - README.md
 - lib/macho.rb
+- lib/macho/code_signing.rb
 - lib/macho/exceptions.rb
 - lib/macho/fat_file.rb
 - lib/macho/headers.rb
@@ -35,7 +35,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+  funding_uri: https://github.com/sponsors/Homebrew
 rdoc_options: []
 require_paths:
 - lib
@@ -43,15 +43,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: ruby-macho - Mach-O file analyzer.
 test_files: []