patchelf 1.5.2 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f11434b437c5d8623134c6c1fe78332b8cbc1251bfd1b0549a560fef7160cf1e
-  data.tar.gz: 742bade914a5ad4e8b1523ad3d1aea9b2a801f89365e087cbc2d7fed0bfe4cba
+  metadata.gz: 64cae3b6070bf26b6716a82886fcb183f20213bf0c396501141e93c1e7951ffa
+  data.tar.gz: 49793e2b2bf154c0d4ff70f1533130495a0161db418248fc39105997159c59c8
 SHA512:
-  metadata.gz: a476877469a6480b277ac318e703eb8d5a5c373b47b095b5c215327207e52b024fc8c38093ef3974fb022f206078c4ae20548d97d861bcc3bcae3e5a0b6727c6
-  data.tar.gz: 4acd3a4e025dec84cefe1b45d09f6aa5425618a12ac3f5bb94a60a3aa9f04a9e5fba68cba8f988be6866a615744ae1f03c3a944812a12513bb4612ade87aa721
+  metadata.gz: d6b6dc9f7caa90f2abe18013a778e4ede2206f848e377e3cfce635b83ffc75b4dbc66c9b318899040bffa9553e8f0820cab95f92af445adc783efbbe47e0395f
+  data.tar.gz: b9566cc7487e8225e07f5ea7a29698e1d280969fde9f93ef0c0b1cd08d11595e92243883ed6123ef3918c1776003939c16a49d89aed6fc5da7a685e92a4a6a5a

data/README.md

@@ -1,11 +1,10 @@
 [![Downloads](https://img.shields.io/endpoint?url=https://gem-badge-h3lg.onrender.com/downloads/patchelf)](https://rubygems.org/gems/patchelf)
 
 [![Gem Version](https://badge.fury.io/rb/patchelf.svg)](https://badge.fury.io/rb/patchelf)
-[![Build Status](https://github.com/david942j/patchelf.rb/workflows/build/badge.svg)](https://github.com/david942j/patchelf.rb/actions)
-[![Maintainability](https://qlty.sh/gh/david942j/projects/patchelf.rb/maintainability.svg)](https://qlty.sh/gh/david942j/projects/patchelf.rb)
-[![Code Coverage](https://qlty.sh/gh/david942j/projects/patchelf.rb/coverage.svg)](https://qlty.sh/gh/david942j/projects/patchelf.rb)
-[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/david942j/patchelf.rb/master)
-[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit/)
+[![CI](https://github.com/Homebrew/patchelf.rb/actions/workflows/tests.yml/badge.svg)](https://github.com/Homebrew/patchelf.rb/actions/workflows/tests.yml)
+[![Coverage Status](https://codecov.io/gh/Homebrew/patchelf.rb/graph/badge.svg)](https://codecov.io/gh/Homebrew/patchelf.rb)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/patchelf)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://choosealicense.com/licenses/mit/)
 
 # patchelf.rb
 
@@ -136,3 +135,16 @@ patcher.save('ls.patch')
 ## Environment
 
 patchelf.rb is implemented in pure Ruby, so it should work in all environments include Linux, macOS, and Windows!
+
+## Project Authors
+
+The git history remains the definitive record of all contributions.
+
+### Original Author and Project Founder
+
+* david942j (@david942j)
+
+### Maintainers
+
+* Homebrew maintainers
+* david942j (@david942j)

data/lib/patchelf/alt_saver.rb

@@ -58,7 +58,7 @@ module PatchELF
       @out_file = out_file
       @set = set
 
-      f = File.open(in_file, 'rb')
+      f = File.open(in_file, 'rb') # rubocop:disable Style/FileOpen
       # the +@buffer+ and +@elf+ both could work on same +StringIO+ stream,
       # the updating of @buffer in place blocks us from looking up old values.
       # TODO: cache the values needed later, use same stream for +@buffer+ and +@elf+.
@@ -130,14 +130,12 @@ module PatchELF
       find_section '.dynstr'
     end
 
-    # yields dynamic tag, and offset in buffer
+    # Yields dynamic tag, and its offset in @buffer.
+    # @yieldparam [ELFTools::Structs::ELF_Dyn] dyn
+    # @yieldparam [Integer] offset The offset of this dynamic tag within +@buffer+.
     def each_dynamic_tags
-      return unless block_given?
-
-      sec = find_section '.dynamic'
-      return unless sec
-
-      return if sec.header.sh_type == ELFTools::Constants::SHT_NOBITS
+      sec = find_section('.dynamic')
+      return if sec.nil? || sec.header.sh_type == ELFTools::Constants::SHT_NOBITS
 
       shdr = sec.header
       with_buf_at(shdr.sh_offset) do |buf|
@@ -149,8 +147,8 @@ module PatchELF
           break if dyn.d_tag == ELFTools::Constants::DT_NULL
 
           yield dyn, buf_dyn_offset
-          # there's a possibility for caller to modify @buffer.pos, seek to avoid such issues
-          buf.seek buf_dyn_offset + dyn.num_bytes
+          # It's possible the caller may modify @buffer.pos, seek to ensure it points to the next tag.
+          buf.seek(buf_dyn_offset + dyn.num_bytes)
         end
       end
     end
@@ -675,18 +673,13 @@ module PatchELF
       new_phdrs = []
 
       while curr_off < end_off
-        size = 0
-        sections_at_aligned_offset(curr_off) do |sec|
-          next if sec.type != ELFTools::Constants::SHT_NOTE
-
-          size = sec.header.sh_size.to_i
-          curr_off = sec.header.sh_offset.to_i
-          break
-        end
+        section = sections_at_aligned_offset(curr_off).find { |sec| sec.type == ELFTools::Constants::SHT_NOTE }
+        raise PatchError, 'cannot normalize PT_NOTE segment: non-contiguous SHT_NOTE sections' if section.nil?
 
-        raise PatchError, 'cannot normalize PT_NOTE segment: non-contiguous SHT_NOTE sections' if size.zero?
+        size = section.header.sh_size.to_i
+        curr_off = section.header.sh_offset.to_i
 
-        if curr_off + size > end_off
+        if size.zero? || curr_off + size > end_off
           raise PatchError, 'cannot normalize PT_NOTE segment: partially mapped SHT_NOTE section'
         end
 
@@ -710,6 +703,8 @@ module PatchELF
     end
 
     def sections_at_aligned_offset(offset)
+      return to_enum(__method__, offset) unless block_given?
+
       @sections.each do |sec|
         shdr = sec.header
 
@@ -743,7 +738,6 @@ module PatchELF
       phdr.p_vaddr -= shift if phdr.p_vaddr > shift
     end
 
-    # rubocop:disable Metrics/PerceivedComplexity
     def shift_segments(shift, start_offset)
       split_index = -1
       split_shift = 0
@@ -752,9 +746,8 @@ module PatchELF
         phdr = seg.header
         p_start = phdr.p_offset
 
-        if p_start <= start_offset && p_start + phdr.p_filesz > start_offset &&
-           phdr.p_type == ELFTools::Constants::PT_LOAD
-          raise PatchError, "split_index(#{split_index}) != -1" if split_index != -1
+        if (p_start...(p_start + phdr.p_filesz)).cover?(start_offset) && phdr.p_type == ELFTools::Constants::PT_LOAD
+          raise PatchError, 'PT_LOAD segments overlapped, unable to shift segments' if split_index != -1
 
           split_index = idx
           split_shift = start_offset - p_start
@@ -775,11 +768,10 @@ module PatchELF
         end
       end
 
-      raise PatchError, "split_index(#{split_index}) == -1" if split_index == -1
+      raise PatchError, "No PT_LOAD found covers offset 0x#{start_offset.to_s(16)}" if split_index == -1
 
       [split_index, split_shift]
     end
-    # rubocop:enable Metrics/PerceivedComplexity
 
     def shift_file(extra_pages, start_offset, extra_bytes)
       raise PatchError, "start_offset(#{start_offset}) < ehdr.num_bytes" if start_offset < ehdr.num_bytes
@@ -865,9 +857,9 @@ module PatchELF
       sec_name
     end
 
-    # given a +dyn.d_tag+, returns the section name it must be synced to.
-    # it may return nil, when given tag maps to no section,
-    # or when its okay to skip if section is not found.
+    # Given a +dyn.d_tag+, returns the section name it must be synced to.
+    # Returns +nil+ when given tag maps to no section, or when its okay to skip if section is not found.
+    # @return [String?]
     def dyn_tag_to_section_name(d_tag)
       case d_tag
       when ELFTools::Constants::DT_STRTAB, ELFTools::Constants::DT_STRSZ
@@ -901,32 +893,37 @@ module PatchELF
       end
     end
 
+    # @return [ELFTools::Structs::ELF_Shdr?]
+    def dyn_tag_to_shdr(d_tag)
+      sec_name = dyn_tag_to_section_name(d_tag)
+      return if sec_name.nil?
+
+      find_section(sec_name)&.header
+    end
+
     # updates dyn tags by syncing it with @section values
     def sync_dyn_tags!
+      # Position of the fist dynamic tag.
       dyn_table_offset = nil
       each_dynamic_tags do |dyn, buf_off|
         dyn_table_offset ||= buf_off
 
-        sec_name = dyn_tag_to_section_name(dyn.d_tag)
-
-        unless sec_name
-          if dyn.d_tag == ELFTools::Constants::DT_MIPS_RLD_MAP_REL && ehdr.e_machine == ELFTools::Constants::EM_MIPS
-            rld_map = find_section('.rld_map')
-            dyn.d_val = if rld_map
-                          rld_map.header.sh_addr.to_i - (buf_off - dyn_table_offset) -
-                            find_section('.dynamic').header.sh_addr.to_i
-                        else
-                          Logger.warn 'DT_MIPS_RLD_MAP_REL entry is present, but .rld_map section is not'
-                          0
-                        end
-          end
+        if dyn.d_tag == ELFTools::Constants::DT_MIPS_RLD_MAP_REL
+          rld_map = find_section('.rld_map')
+          dyn.d_val = if rld_map
+                        rld_map.header.sh_addr.to_i - (buf_off - dyn_table_offset) -
+                          find_section('.dynamic').header.sh_addr.to_i
+                      else
+                        Logger.warn 'DT_MIPS_RLD_MAP_REL entry is present, but .rld_map section is not'
+                        0
+                      end
+        else
+          shdr = dyn_tag_to_shdr(dyn.d_tag)
+          next if shdr.nil?
 
-          next
+          dyn.d_val = dyn.d_tag == ELFTools::Constants::DT_STRSZ ? shdr.sh_size.to_i : shdr.sh_addr.to_i
         end
 
-        shdr = find_section(sec_name).header
-        dyn.d_val = dyn.d_tag == ELFTools::Constants::DT_STRSZ ? shdr.sh_size.to_i : shdr.sh_addr.to_i
-
         with_buf_at(buf_off) { |wbuf| dyn.write(wbuf) }
       end
     end
@@ -945,6 +942,8 @@ module PatchELF
       nil
     end
 
+    # Some sections have their corresponding segment.
+    # Use this utility when a section is being patched so its segment should be updated with the same values.
     def sync_sec_to_seg(shdr, phdr)
       phdr.p_offset = shdr.sh_offset.to_i
       phdr.p_vaddr = phdr.p_paddr = shdr.sh_addr.to_i
@@ -962,6 +961,8 @@ module PatchELF
     end
 
     # Returns a blank shdr if the section doesn't exist.
+    #
+    # @return [ELFTools::Structs::ELF_Shdr]
     def find_or_create_section_header(rsec_name)
       shdr = find_section(rsec_name)&.header
       shdr ||= ELFTools::Structs::ELF_Shdr.new(endian: endian, elf_class: elf_class)
@@ -991,11 +992,54 @@ module PatchELF
       (s_start >= p_start && s_start < p_end) || (s_end > p_start && s_end <= p_end)
     end
 
+    # Used when patching sections.
+    # For sections with a correspondence segment, update the segment values.
+    # @return [void]
+    def section_sync_correspondence_segment(sec_name, shdr)
+      seg_type = {
+        '.interp' => ELFTools::Constants::PT_INTERP,
+        '.dynamic' => ELFTools::Constants::PT_DYNAMIC,
+        '.MIPS.abiflags' => ELFTools::Constants::PT_MIPS_ABIFLAGS,
+        '.note.gnu.property' => ELFTools::Constants::PT_GNU_PROPERTY
+      }[sec_name]
+      return if seg_type.nil?
+
+      phdrs_by_type(seg_type) { |phdr| sync_sec_to_seg(shdr, phdr) }
+    end
+
+    # Similar to +section_sync_correspondence_segment+ but dedicate for note sections as it is allowed to have multiple
+    # note segments.
+    # This function searches all note segments and only sync the one matched with the section values before patching.
+    #
+    # NOTE: This function is no-op if +shdr+ does not have section type +ELFTools::Constants::SHT_NOTE+.
+    #
+    # @param [Integer] orig_sh_offset The original section offset value.
+    # @param [Integer] orig_sh_size The original section size value.
+    # @param [ELFTools::Structs::ELF_Shdr] shdr The section header with values after patched.
+    #
+    # @return [void]
+    def sync_note_segment(orig_sh_offset, orig_sh_size, shdr)
+      return if shdr.sh_type != ELFTools::Constants::SHT_NOTE
+
+      phdrs_by_type(ELFTools::Constants::PT_NOTE) do |phdr|
+        s_start = orig_sh_offset
+        s_end = s_start + orig_sh_size
+        p_start = phdr.p_offset
+        p_end = p_start + phdr.p_filesz
+
+        # Skip if no overlap.
+        next unless section_bounds_within_segment?(s_start, s_end, p_start, p_end)
+
+        # Only support exact matches.
+        raise PatchError, 'unsupported overlap of SHT_NOTE and PT_NOTE' unless [p_start, p_end] == [s_start, s_end]
+
+        sync_sec_to_seg(shdr, phdr)
+      end
+    end
+
     def write_replaced_sections(cur_off, start_addr, start_offset)
       overwrite_replaced_sections
 
-      noted_phdrs = Set.new
-
       # the sort is necessary, the strategy in ruby and Cpp to iterate map/hash
       # is different, patchelf v0.10 iterates the replaced_sections sorted by
       # keys.
@@ -1018,34 +1062,8 @@ module PatchELF
         shdr.sh_size = rsec_data.size
 
         write_section_alignment(shdr)
-
-        seg_type = {
-          '.interp' => ELFTools::Constants::PT_INTERP,
-          '.dynamic' => ELFTools::Constants::PT_DYNAMIC,
-          '.MIPS.abiflags' => ELFTools::Constants::PT_MIPS_ABIFLAGS,
-          '.note.gnu.property' => ELFTools::Constants::PT_GNU_PROPERTY
-        }[rsec_name]
-
-        phdrs_by_type(seg_type) { |phdr| sync_sec_to_seg(shdr, phdr) }
-
-        if shdr.sh_type == ELFTools::Constants::SHT_NOTE
-          phdrs_by_type(ELFTools::Constants::PT_NOTE) do |phdr, idx|
-            next if noted_phdrs.include?(idx)
-
-            s_start = orig_sh_offset
-            s_end = s_start + orig_sh_size
-            p_start = phdr.p_offset
-            p_end = p_start + phdr.p_filesz
-
-            next unless section_bounds_within_segment?(s_start, s_end, p_start, p_end)
-
-            raise PatchError, 'unsupported overlap of SHT_NOTE and PT_NOTE' if p_start != s_start || p_end != s_end
-
-            sync_sec_to_seg(shdr, phdr)
-
-            noted_phdrs << idx
-          end
-        end
+        section_sync_correspondence_segment(rsec_name, shdr)
+        sync_note_segment(orig_sh_offset, orig_sh_size, shdr)
 
         cur_off += Helper.alignup(rsec_data.size, @section_alignment)
       end

data/lib/patchelf/cli.rb

@@ -9,7 +9,7 @@ module PatchELF
   # For command line interface to parsing arguments.
   module CLI
     # Name of binary.
-    SCRIPT_NAME = 'patchelf.rb'.freeze
+    SCRIPT_NAME = 'patchelf.rb'
     # CLI usage string.
     USAGE = format('Usage: %s <commands> FILENAME [OUTPUT_FILE]', SCRIPT_NAME).freeze
 

data/lib/patchelf/patcher.rb

@@ -29,7 +29,7 @@ module PatchELF
     #     :silent = ignore the errors
     def initialize(filename, on_error: :log, logging: true)
       @in_file = filename
-      f = File.open(filename)
+      f = File.open(filename) # rubocop:disable Style/FileOpen
       @elf = ELFTools::ELFFile.new(f)
       @set = {}
       @rpath_sym = :runpath

data/lib/patchelf/saver.rb

@@ -32,7 +32,7 @@ module PatchELF
       @set = set
       # [{Integer => String}]
       @inline_patch = {}
-      f = File.open(in_file)
+      f = File.open(in_file) # rubocop:disable Style/FileOpen
       @elf = ELFTools::ELFFile.new(f)
       @mm = PatchELF::MM.new(@elf)
       @strtab_extend_requests = []

data/lib/patchelf/version.rb

@@ -2,5 +2,5 @@
 
 module PatchELF
   # Current gem version.
-  VERSION = '1.5.2'.freeze
+  VERSION = '1.6.2'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: patchelf
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.2
 platform: ruby
 authors:
 - david942j
 bindir: bin
 cert_chain: []
-date: 2025-11-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elftools
@@ -93,6 +93,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: tty-platform
   requirement: !ruby/object:Gem::Requirement
@@ -144,11 +158,14 @@ files:
 - lib/patchelf/patcher.rb
 - lib/patchelf/saver.rb
 - lib/patchelf/version.rb
-homepage: https://github.com/david942j/patchelf.rb
+homepage: https://github.com/Homebrew/patchelf.rb
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/Homebrew/patchelf.rb
+  bug_tracker_uri: https://github.com/Homebrew/patchelf.rb/issues
+  funding_uri: https://github.com/sponsors/Homebrew
 rdoc_options: []
 require_paths:
 - lib
@@ -156,14 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.16
 specification_version: 4
 summary: patchelf
 test_files: []