patchelf 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1e44d5adb39d260d124ebc5231362a134e0719cf2f4a379ddab0d4a7343db66
-  data.tar.gz: a1cdf1d41641b728e205de2559c86eb4fb7a98f09d6a1882123310edf6701bcf
+  metadata.gz: f11434b437c5d8623134c6c1fe78332b8cbc1251bfd1b0549a560fef7160cf1e
+  data.tar.gz: 742bade914a5ad4e8b1523ad3d1aea9b2a801f89365e087cbc2d7fed0bfe4cba
 SHA512:
-  metadata.gz: 432fd63c969cd337644e4360dbc110a0fae0aaba480174ea3162ddab17814fea9eceeff266cc2f98c571b06830f4ff94ac148b762c49d6fe2135cb692a212a29
-  data.tar.gz: 9d7b9769ae80913cbc621801f6caee0e1e61ccbc32514302f892e7ecbff3c8439ae89557c1bb3b10d27e21732fe1e7a36bf8be12b8296237a3f6dd39a6b76c3b
+  metadata.gz: a476877469a6480b277ac318e703eb8d5a5c373b47b095b5c215327207e52b024fc8c38093ef3974fb022f206078c4ae20548d97d861bcc3bcae3e5a0b6727c6
+  data.tar.gz: 4acd3a4e025dec84cefe1b45d09f6aa5425618a12ac3f5bb94a60a3aa9f04a9e5fba68cba8f988be6866a615744ae1f03c3a944812a12513bb4612ade87aa721

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 david942j
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,9 +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)
-[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=david942j/patchelf.rb)](https://dependabot.com)
-[![Code Climate](https://codeclimate.com/github/david942j/patchelf.rb/badges/gpa.svg)](https://codeclimate.com/github/david942j/patchelf.rb)
-[![Issue Count](https://codeclimate.com/github/david942j/patchelf.rb/badges/issue_count.svg)](https://codeclimate.com/github/david942j/patchelf.rb)
-[![Test Coverage](https://codeclimate.com/github/david942j/patchelf.rb/badges/coverage.svg)](https://codeclimate.com/github/david942j/patchelf.rb/coverage)
-[![Inline docs](https://inch-ci.org/github/david942j/patchelf.rb.svg?branch=master)](https://inch-ci.org/github/david942j/patchelf.rb)
+[![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/)
 
 # patchelf.rb

data/lib/patchelf/alt_saver.rb

@@ -5,6 +5,7 @@ require 'elftools/elf_file'
 require 'elftools/structs'
 require 'elftools/util'
 require 'fileutils'
+require 'objspace'
 
 require 'patchelf/helper'
 
@@ -65,6 +66,9 @@ module PatchELF
       @elf = ELFTools::ELFFile.new(f)
       @buffer = StringIO.new(f.tap(&:rewind).read) # StringIO makes easier to work with Bindata
 
+      # Ensure file is closed when the {AltSaver} object is garbage collected.
+      ObjectSpace.define_finalizer(self, Helper.close_file_proc(f))
+
       @ehdr = @elf.header
       @endian = @elf.endian
       @elf_class = @elf.elf_class
@@ -451,10 +455,10 @@ module PatchELF
 
           begin
             new_index = new_section_idx(old_shndx)
-            next unless new_index
           rescue ArgumentError
             Logger.warn "entry #{entry} in symbol table refers to a non existing section, skipping"
           end
+          next unless new_index
 
           sym[pack[:st_shndx]] = new_index
 
@@ -561,11 +565,12 @@ module PatchELF
       if needed_space > start_offset
         needed_space += seg_num_bytes # new load segment is required
 
-        needed_pages = Helper.alignup(needed_space - start_offset, page_size) / page_size
+        extra_bytes = needed_space - start_offset
+        needed_pages = Helper.alignup(extra_bytes, page_size) / page_size
         Logger.debug "needed pages is #{needed_pages}"
         raise PatchError, 'virtual address space underrun' if needed_pages * page_size > first_page
 
-        shift_file(needed_pages, start_offset)
+        shift_file(needed_pages, start_offset, extra_bytes)
 
         first_page -= needed_pages * page_size
         start_offset += needed_pages * page_size
@@ -574,7 +579,7 @@ module PatchELF
 
       cur_off = ehdr.num_bytes + (@segments.count * seg_num_bytes)
       Logger.debug "clearing first #{start_offset - cur_off} bytes"
-      with_buf_at(cur_off) { |buf| buf.fill("\x00", (start_offset - cur_off)) }
+      with_buf_at(cur_off) { |buf| buf.fill("\x00", start_offset - cur_off) }
 
       cur_off = write_replaced_sections cur_off, first_page, 0
       raise PatchError, "cur_off(#{cur_off}) != needed_space" if cur_off != needed_space
@@ -776,7 +781,7 @@ module PatchELF
     end
     # rubocop:enable Metrics/PerceivedComplexity
 
-    def shift_file(extra_pages, start_offset)
+    def shift_file(extra_pages, start_offset, extra_bytes)
       raise PatchError, "start_offset(#{start_offset}) < ehdr.num_bytes" if start_offset < ehdr.num_bytes
 
       oldsz = @buffer.size
@@ -799,8 +804,8 @@ module PatchELF
         p_offset: split_phdr.p_offset - split_shift - shift,
         p_vaddr: split_phdr.p_vaddr - split_shift - shift,
         p_paddr: split_phdr.p_paddr - split_shift - shift,
-        p_filesz: split_shift + shift,
-        p_memsz: split_shift + shift,
+        p_filesz: split_shift + extra_bytes,
+        p_memsz: split_shift + extra_bytes,
         p_flags: ELFTools::Constants::PF_R | ELFTools::Constants::PF_W,
         p_align: page_size
       )

data/lib/patchelf/cli.rb

@@ -31,7 +31,7 @@ module PatchELF
         needed: []
       }
       return $stdout.puts "PatchELF Version #{PatchELF::VERSION}" if argv.include?('--version')
-      return $stdout.puts option_parser unless parse(argv)
+      return $stdout.puts option_parser unless parse?(argv)
 
       # Now the options are (hopefully) valid, let's process the ELF file.
       begin
@@ -71,7 +71,7 @@ module PatchELF
       end
     end
 
-    def parse(argv)
+    def parse?(argv)
       remain = option_parser.permute(argv)
       return false if remain.first.nil?
 

data/lib/patchelf/helper.rb

@@ -78,7 +78,14 @@ module PatchELF
     #   alignup(0x10, 0x8)
     #   #=> 16
     def alignup(val, align = page_size)
-      (val & (align - 1)).zero? ? val : (aligndown(val, align) + align)
+      val.nobits?(align - 1) ? val : (aligndown(val, align) + align)
+    end
+
+    # @param [File?] file
+    # @return [Proc]
+    #   A proc that closes the file if it's open.
+    def close_file_proc(file)
+      proc { file.close if file && !file.closed? }
     end
   end
 end

data/lib/patchelf/mm.rb

@@ -49,7 +49,7 @@ module PatchELF
       abnormal_elf('No LOAD segment found, not an executable.') if load_segments.empty?
       # TODO: Handle only one LOAD. (be careful if memsz > filesz)
 
-      fgap_method || mgap_method || new_load_method
+      fgap_method? || mgap_method? || new_load_method
     end
 
     # Query if extended.
@@ -72,25 +72,25 @@ module PatchELF
 
     private
 
-    def fgap_method
+    def fgap_method?
       idx = find_gap { |prv, nxt| nxt.file_head - prv.file_tail }
       return false if idx.nil?
 
       loads = load_segments
       # prefer extend backwardly
-      return extend_backward(loads[idx - 1]) if writable?(loads[idx - 1])
+      return extend_backward?(loads[idx - 1]) if writable?(loads[idx - 1])
 
-      extend_forward(loads[idx])
+      extend_forward?(loads[idx])
     end
 
-    def extend_backward(seg, size = @request_size)
+    def extend_backward?(seg, size = @request_size)
       invoke_callbacks(seg, seg.file_tail)
       seg.header.p_filesz += size
       seg.header.p_memsz += size
       true
     end
 
-    def extend_forward(seg, size = @request_size)
+    def extend_forward?(seg, size = @request_size)
       seg.header.p_offset -= size
       seg.header.p_vaddr -= size
       seg.header.p_filesz += size
@@ -99,7 +99,7 @@ module PatchELF
       true
     end
 
-    def mgap_method
+    def mgap_method?
       # |  1  | |  2  |
       # |  1  |        |  2  |
       #=>
@@ -113,10 +113,10 @@ module PatchELF
       @extend_size = PatchELF::Helper.alignup(@request_size)
       shift_attributes
       # prefer backward than forward
-      return extend_backward(loads[idx - 1]) if writable?(loads[idx - 1])
+      return extend_backward?(loads[idx - 1]) if writable?(loads[idx - 1])
 
       # NOTE: loads[idx].file_head has been changed in shift_attributes
-      extend_forward(loads[idx], @extend_size)
+      extend_forward?(loads[idx], @extend_size)
     end
 
     def find_gap(check_sz: true)

data/lib/patchelf/patcher.rb

@@ -2,8 +2,10 @@
 # frozen_string_literal: true
 
 require 'elftools/elf_file'
+require 'objspace'
 
 require 'patchelf/exceptions'
+require 'patchelf/helper'
 require 'patchelf/logger'
 require 'patchelf/saver'
 
@@ -27,13 +29,17 @@ module PatchELF
     #     :silent = ignore the errors
     def initialize(filename, on_error: :log, logging: true)
       @in_file = filename
-      @elf = ELFTools::ELFFile.new(File.open(filename))
+      f = File.open(filename)
+      @elf = ELFTools::ELFFile.new(f)
       @set = {}
       @rpath_sym = :runpath
       @on_error = logging ? on_error : :exception
 
       on_error_syms = %i[exception log silent]
       raise ArgumentError, "on_error must be one of #{on_error_syms}" unless on_error_syms.include?(@on_error)
+
+      # Ensure file is closed when the {Patcher} object is garbage collected.
+      ObjectSpace.define_finalizer(self, Helper.close_file_proc(f))
     end
 
     # @return [String?]

data/lib/patchelf/saver.rb

@@ -5,10 +5,15 @@ require 'elftools/elf_file'
 require 'elftools/structs'
 require 'elftools/util'
 require 'fileutils'
+require 'objspace'
 
+require 'patchelf/helper'
 require 'patchelf/mm'
 
 module PatchELF
+  # To mark a not-using tag
+  IGNORE = ELFTools::Constants::DT_LOOS
+
   # Internal use only.
   #
   # For {Patcher} to do patching things and save to file.
@@ -27,10 +32,14 @@ module PatchELF
       @set = set
       # [{Integer => String}]
       @inline_patch = {}
-      @elf = ELFTools::ELFFile.new(File.open(in_file))
+      f = File.open(in_file)
+      @elf = ELFTools::ELFFile.new(f)
       @mm = PatchELF::MM.new(@elf)
       @strtab_extend_requests = []
       @append_dyn = []
+
+      # Ensure file is closed when the {Saver} object is garbage collected.
+      ObjectSpace.define_finalizer(self, Helper.close_file_proc(f))
     end
 
     # @return [void]
@@ -116,8 +125,6 @@ module PatchELF
       end
     end
 
-    # To mark a not-using tag
-    IGNORE = ELFTools::Constants::DT_LOOS
     def patch_needed
       original_needs = dynamic.tags_by_type(:needed)
       @set[:needed].uniq!

data/lib/patchelf/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: patchelf
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - david942j
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2025-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elftools
@@ -24,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +131,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - bin/patchelf.rb
 - lib/patchelf.rb
@@ -135,7 +149,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -150,8 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: patchelf
 test_files: []