image_processing 1.14.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 613676364c0ba04b655a087a89296cec4604c8f362809ada23d984538f9e962b
-  data.tar.gz: 77a768424b857418d131257ce2c539715aa69999da7e78319255d9eee3f68157
+  metadata.gz: a52c42f1463cc15caf0dfe57bc8a5efeb464006a2a29bbf1b8c842ada339e4aa
+  data.tar.gz: 2344e1015b02f4b24363371d8877bdcc4fb28b9fb820e15d2e2446f7874443c6
 SHA512:
-  metadata.gz: ff2e1a9bf128d872ad2c5663525c4e970e8b18457f2b4f0a50588a9f33c736b0ef46a3fb4bd10638be5a276e9aa8bacbae09c9685b954416902de3687a3b2181
-  data.tar.gz: c7efff88134c14c44001ea99ed7632ecc86b93bd3afe5e933cfdc8cb2d57a82fc69333192777ac17cdf9e5bf5ef15e012c17e6c7dffbd7124ed58d765e4bff4b
+  metadata.gz: 90c29ed45d475cc54f814a368e894504f5bc012835ef989d3678568dfb3cd29aca144e88cb17d102ffc82dcbd94c4d46de7d9a5fbc0474c0f6b15c481a1f4bb3
+  data.tar.gz: 8a7f991cf00725e1d5618add34f9b57814e2e273d8b9575f49e61701e80259ac8c2cd61028cdaefc6b4a6694a8a922d2246f5f6b8f7ee7184ff31bd0f8644813

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## 2.1.0 (2026-09-01)
+
+* [minimagick] Add `inherit_fds:` so a loader can name an already-open input (thanks to @flavorjones)
+
+## 2.0.3 (2026-08-06)
+
+* Prevent remote code execution when operation names come from user input, closing bypasses through the `#operation` meta-builder, `#method_missing`, and nested `#send` calls (reported by @szymonsec)
+
+* [minimagick] Prevent remote code execution through unsafe public methods (e.g. `#instance_eval`, `#send`) passed as loader/saver option names
+
+## 2.0.2 (2026-06-03)
+
+* Raise `LoadError` instead of `ImageProcessing::Error` when soft dependencies are missing (@bdewater-thatch)
+
+## 2.0.1 (2026-05-22)
+
+* [minimagick] Prevent remote shell execution when passing loader/saver options from user input
+
+## 2.0.0 (2026-05-20)
+
+* `mini_magick`/`ruby-vips` are now soft dependencies and need to be manually added to the Gemfile (@janko)
+
+* Avoid remote shell execution vulnerability in `#apply` when arguments are coming from user input (@janko)
+
+* [vips] Unfuzzed loaders are now blocked by default (@janko)
+
+* [vips] Sharpening after resize has been disabled by default (@janko)
+
+* [minimagick] Remove deprecated `:compose` and `:geometry` keyword arguments for `#composite` (@janko)
+
+* Ruby 3.0+ is now required (@janko)
+
 ## 1.14.0 (2025-02-10)
 
 * Add support for MiniMagick 5.x (@lukeasrodgers)

data/README.md

@@ -3,11 +3,10 @@
 Provides higher-level image processing helpers that are commonly needed
 when handling image uploads.
 
-This gem can process images with either [ImageMagick]/[GraphicsMagick] or
-[libvips] libraries. ImageMagick is a good default choice, especially if you
-are migrating from another gem or library that uses ImageMagick. Libvips is a
-newer library that can process images [very rapidly][libvips performance]
-(often multiple times faster than ImageMagick).
+This gem can process images with [ImageMagick] or [libvips]. ImageMagick is a
+good default choice, especially if you are migrating from another gem or library
+that uses ImageMagick. Libvips is a newer library that can process images [very
+rapidly][libvips performance] (often multiple times faster than ImageMagick).
 
 
 ## Goal
@@ -16,7 +15,7 @@ The goal of this project is to have a single gem that contains all the
 helper methods needed to resize and process images.
 
 Currently, existing attachment gems (like Paperclip, CarrierWave, Refile,
-Dragonfly, ActiveStorage, and others) implement their own custom image
+Dragonfly, Active Storage, and others) implement their own custom image
 helper methods. But why? That's not very DRY, is it?
 
 Let's be honest. Image processing is a dark, mysterious art. So we want to
@@ -32,19 +31,23 @@ how to resize and process images.
 In a Mac terminal:
 
 ```sh
-  $ brew install imagemagick vips
+  $ brew install imagemagick # if using ImageMagick
+  $ brew install vips # if using libvips
   ```
 
  In a debian/ubuntu terminal:
 
 ```sh
-  $ sudo apt install imagemagick libvips
+  $ sudo apt install imagemagick # if using ImageMagick
+  $ sudo apt install libvips # if using libvips
   ```
 
-2. Add the gem to your Gemfile:
+2. Add the gem(s) to your Gemfile:
 
   ```rb
-  gem "image_processing", "~> 1.0"
+  gem "image_processing", "~> 2.0"
+  gem "mini_magick", "~> 5.0" # if using ImageMagick
+  gem "ruby-vips", "~> 2.0" # if using libvips
   ```
 
 
@@ -66,7 +69,7 @@ processed = ImageProcessing::MiniMagick
 processed #=> #<Tempfile:/var/folders/.../image_processing20180316-18446-1j247h6.png>
 ```
 
-This allows easy branching when generating multiple derivates:
+This allows easy branching when generating multiple derivatives:
 
 ```rb
 require "image_processing/vips"
@@ -187,22 +190,9 @@ pipeline
 
 ## Contributing
 
-Our test suite requires both `imagemagick` and `libvips` libraries to be installed.
+Our test suite requires both `imagemagick` and `libvips` libraries to be installed. Afterwards you can run tests with:
 
-In a Mac terminal:
-
-```
-$ brew install imagemagick vips
-```
-
-In a debian/ubuntu terminal:
-```shell
-sudo apt install imagemagick libvips
-```
-
-Afterwards you can run tests with
-
-```
+```sh
 $ bundle exec rake test
 ```
 

data/image_processing.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.name          = "image_processing"
   spec.version       = ImageProcessing::VERSION
 
-  spec.required_ruby_version = ">= 2.3"
+  spec.required_ruby_version = ">= 3.0"
 
   spec.summary       = "High-level wrapper for processing images for the web with ImageMagick or libvips."
   spec.description   = "High-level wrapper for processing images for the web with ImageMagick or libvips."
@@ -19,12 +19,8 @@ Gem::Specification.new do |spec|
   spec.metadata = { "changelog_uri" => spec.homepage + "/blob/master/CHANGELOG.md",
                     "rubygems_mfa_required" => "true" }
 
-  spec.add_dependency "mini_magick", ">= 4.9.5", "< 6"
-  spec.add_dependency "ruby-vips", ">= 2.0.17", "< 3"
-
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.8"
   spec.add_development_dependency "minitest-hooks", ">= 1.4.2"
   spec.add_development_dependency "minispec-metadata"
-  spec.add_development_dependency "dhash-vips"
 end

data/lib/image_processing/chainable.rb

@@ -33,6 +33,10 @@ module ImageProcessing
     #   .apply([[:resize_to_limit, [400, 400]], [:strip, true])
     def apply(operations)
       operations.inject(self) do |builder, (name, argument)|
+        if invalid_operation?(name)
+          fail ArgumentError, "#{name.inspect} is not a valid ImageProcessing operation"
+        end
+
         if argument == true || argument == nil
           builder.public_send(name)
         elsif argument.is_a?(Array)
@@ -81,15 +85,25 @@ module ImageProcessing
 
     private
 
+    # This prevents calling unsafe Ruby core methods such as `Kernel#system`,
+    # which would allow for remote shell execution. The processor enforces the
+    # same guard when operations are dispatched, which also covers paths that
+    # bypass this early check (e.g. the #operation meta-builder).
+    #
+    # Bang names are rejected here because they are Chainable's execution
+    # shortcut (see #method_missing), not operations to chain.
+    def invalid_operation?(name)
+      name.end_with?("!") || ImageProcessing.unsafe_method?(self, name)
+    end
+
     # Assume that any unknown method names an operation supported by the
     # processor. Add a bang ("!") if you want processing to be performed.
-    def method_missing(name, *args, &block)
-      return super if name.to_s.end_with?("?")
-      return send(name.to_s.chomp("!"), *args, &block).call if name.to_s.end_with?("!")
+    def method_missing(name, ...)
+      return super if name.end_with?("?")
+      return public_send(name.to_s.chomp("!"), ...).call if name.end_with?("!")
 
-      operation(name, *args, &block)
+      operation(name, ...)
     end
-    ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
 
     # Empty options which the builder starts with.
     DEFAULT_OPTIONS = {

data/lib/image_processing/mini_magick.rb

@@ -1,15 +1,28 @@
-require "mini_magick"
 require "image_processing"
+begin
+  require "mini_magick"
+rescue LoadError
+  raise LoadError, "ImageProcessing::MiniMagick requires the mini_magick gem. Please add `gem \"mini_magick\", \"~> 5.0\"` to your Gemfile."
+end
 
 module ImageProcessing
   module MiniMagick
     extend Chainable
 
-    def self.convert_shim(&block)
+    # mini_magick gained `inherit_fds:` on MiniMagick::Shell#execute in 5.4.0.
+    INHERIT_FDS_MINIMUM_VERSION = Gem::Version.new("5.4.0")
+
+    def self.convert_shim(inherit_fds: nil, &block)
+      if inherit_fds && ::MiniMagick.version < INHERIT_FDS_MINIMUM_VERSION
+        raise LoadError, "The `inherit_fds` loader option requires mini_magick #{INHERIT_FDS_MINIMUM_VERSION} or newer, but mini_magick #{::MiniMagick.version} is loaded. Please upgrade the gem."
+      end
+
+      options = inherit_fds ? { inherit_fds: inherit_fds } : {}
+
       if ::MiniMagick.respond_to?(:convert)
-        ::MiniMagick.convert(&block)
+        ::MiniMagick.convert(**options, &block)
       else
-        ::MiniMagick::Tool::Convert.new(&block)
+        ::MiniMagick::Tool::Convert.new(**options, &block)
       end
     end
 
@@ -33,12 +46,16 @@ module ImageProcessing
       # Initializes the image on disk into a MiniMagick::Tool object. Accepts
       # additional options related to loading the image (e.g. geometry).
       # Additionally auto-orients the image to be upright.
-      def self.load_image(path_or_magick, loader: nil, page: nil, geometry: nil, auto_orient: true, **options)
+      # `inherit_fds` names IO objects the tool inherits, so the source may be a
+      # `/dev/fd/N` path. The source stays a path, so `loader`, `page` and
+      # `geometry` still apply to it, which they would not if the caller passed
+      # a pre-built MiniMagick::Tool carrying the descriptor.
+      def self.load_image(path_or_magick, loader: nil, page: nil, geometry: nil, auto_orient: true, inherit_fds: nil, **options)
         if path_or_magick.is_a?(::MiniMagick::Tool)
           magick = path_or_magick
         else
           source_path = path_or_magick
-          magick = ::ImageProcessing::MiniMagick.convert_shim
+          magick = ::ImageProcessing::MiniMagick.convert_shim(inherit_fds: inherit_fds)
 
           Utils.apply_options(magick, **options)
 
@@ -120,18 +137,9 @@ module ImageProcessing
       # Overlays the specified image over the current one. Supports specifying
       # an additional mask, composite mode, direction or offset of the overlay
       # image.
-      def composite(overlay = :none, mask: nil, mode: nil, gravity: nil, offset: nil, args: nil, **options, &block)
+      def composite(overlay = :none, mask: nil, mode: nil, gravity: nil, offset: nil, args: nil, &block)
         return magick.composite if overlay == :none
 
-        if options.key?(:compose)
-          warn "[IMAGE_PROCESSING] The :compose parameter in #composite has been renamed to :mode, the :compose alias will be removed in ImageProcessing 2."
-          mode = options[:compose]
-        end
-
-        if options.key?(:geometry)
-          warn "[IMAGE_PROCESSING] The :geometry parameter in #composite has been deprecated and will be removed in ImageProcessing 2. Use :offset instead, e.g. `geometry: \"+10+15\"` should be replaced with `offset: [10, 15]`."
-          geometry = options[:geometry]
-        end
         geometry = "%+d%+d" % offset if offset
 
         overlay_path = convert_to_path(overlay, "overlay")
@@ -230,10 +238,17 @@ module ImageProcessing
         # Applies options from the provided hash.
         def apply_options(magick, define: {}, **options)
           options.each do |option, value|
+            # Loader/saver option names may come from user input, so guard
+            # against dispatching to unsafe Ruby core methods (e.g. #send,
+            # #instance_eval) that public_send does not block on its own.
+            if ImageProcessing.unsafe_method?(magick, option)
+              raise Error, "#{option.inspect} is not a valid option"
+            end
+
             case value
-            when true, nil then magick.send(option)
-            when false     then magick.send(option).+
-            else                magick.send(option, *value)
+            when true, nil then magick.public_send(option)
+            when false     then magick.public_send(option).+
+            else                magick.public_send(option, *value)
             end
           end
 

data/lib/image_processing/processor.rb

@@ -53,6 +53,15 @@ module ImageProcessing
     # operation directly on the accumulator object. This provides a common
     # umbrella above defined macros and direct operations.
     def apply_operation(name, *args, &block)
+      # Chainable performs the same check when operations are built, but that
+      # guard only sees the outer builder method name, so it can be routed
+      # around via the #operation meta-builder, #method_missing, or a nested
+      # #send. This is the single point every operation is finally dispatched
+      # through, so enforcing the guard here closes all of those paths.
+      if ImageProcessing.unsafe_method?(self, name)
+        fail Error, "#{name.inspect} is not a valid operation"
+      end
+
       receiver = respond_to?(name) ? self : @accumulator
 
       if args.last.is_a?(Hash)

data/lib/image_processing/version.rb

@@ -1,3 +1,3 @@
 module ImageProcessing
-  VERSION = "1.14.0"
+  VERSION = "2.1.0"
 end

data/lib/image_processing/vips.rb

@@ -1,7 +1,11 @@
-require "vips"
 require "image_processing"
+begin
+  require "vips"
+rescue LoadError
+  raise LoadError, "ImageProcessing::Vips requires the ruby-vips gem. Please add `gem \"ruby-vips\", \"~> 2.0\"` to your Gemfile."
+end
 
-fail "image_processing/vips requires libvips 8.6+" unless Vips.at_least_libvips?(8, 6)
+Vips.block_untrusted(true) if Vips.respond_to?(:block_untrusted) && !ENV["VIPS_BLOCK_UNTRUSTED"]
 
 module ImageProcessing
   module Vips
@@ -155,7 +159,7 @@ module ImageProcessing
 
       # Resizes the image according to the specified parameters, and sharpens
       # the resulting thumbnail.
-      def thumbnail(width, height, sharpen: SHARPEN_MASK, **options)
+      def thumbnail(width, height, sharpen: nil, **options)
         if self.image.is_a?(String) # path
           # resize on load
           image = ::Vips::Image.thumbnail(self.image, width, height: height, **options)
@@ -167,7 +171,11 @@ module ImageProcessing
           image = self.image.thumbnail_image(width, height: height, **options)
         end
 
-        image = image.conv(sharpen, precision: :integer) if sharpen
+        if sharpen
+          sharpen_mask = sharpen.is_a?(TrueClass) ? SHARPEN_MASK : sharpen
+          image = image.conv(sharpen_mask, precision: :integer)
+        end
+
         image
       end
 

data/lib/image_processing.rb

@@ -7,6 +7,25 @@ require "image_processing/version"
 module ImageProcessing
   Error = Class.new(StandardError)
 
-  autoload :MiniMagick, 'image_processing/mini_magick'
-  autoload :Vips, 'image_processing/vips'
+  # Method owners considered unsafe to dispatch to when a method name comes
+  # from user input, because they expose Ruby's metaprogramming and shell
+  # primitives (e.g. Kernel#send, Kernel#eval, BasicObject#instance_eval,
+  # Kernel#system). Any name whose implementation is inherited from one of
+  # these should never be treated as an image operation or a loader/saver
+  # option.
+  UNSAFE_METHOD_OWNERS = [BasicObject, Kernel, Object, Module].freeze
+
+  # Whether calling +name+ on +receiver+ would dispatch to an unsafe Ruby core
+  # method rather than a genuine operation. Used as a single, shared guard at
+  # every place where a user-provided name is dispatched via +public_send+.
+  def self.unsafe_method?(receiver, name)
+    UNSAFE_METHOD_OWNERS.include?(receiver.method(name.to_s).owner)
+  rescue NameError
+    # An unknown name is not a Ruby core method, so it is safe to forward to
+    # the receiver (which will reject it if it is not a real operation).
+    false
+  end
+
+  autoload :MiniMagick, "image_processing/mini_magick"
+  autoload :Vips, "image_processing/vips"
 end

metadata

@@ -1,54 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_processing
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Janko Marohnić
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: mini_magick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.9.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.9.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-- !ruby/object:Gem::Dependency
-  name: ruby-vips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.17
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.17
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -105,20 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: dhash-vips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: High-level wrapper for processing images for the web with ImageMagick
   or libvips.
 email:
@@ -152,14 +98,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.13
 specification_version: 4
 summary: High-level wrapper for processing images for the web with ImageMagick or
   libvips.