Skip to content

A platform for community discussion. Free, open, simple.

DEV: Refactor `DiscourseVips` to require read/write permissions (#43764)

Alan Guo Xiang Tan670dd6be75cb
diff --git a/lib/discourse_vips.rb b/lib/discourse_vips.rb
index 74fb53eb3c3..4b3134cb658 100644
--- a/lib/discourse_vips.rb
+++ b/lib/discourse_vips.rb
@@ -7,13 +7,15 @@ module DiscourseVips
private_constant :SVG_DIMENSIONS_TIMEOUT_SECONDS
def self.version
- Client.call(["version"], operation: :vips_version)
+ Client.call(["version"], operation: :vips_version, read: [], write: [])
end
def self.letter_avatar(letter:, output_path:, background_color:, font:, font_path:)
Client.call(
["letter-avatar", letter, output_path, background_color, font, font_path],
operation: :letter_avatar_render,
+ read: ["/etc/fonts", "/var/cache/fontconfig", font_path],
+ write: [File.dirname(output_path)],
)
end
@@ -21,6 +23,8 @@ module DiscourseVips
Client.call(
["dominant-color", input_path],
operation: :upload_dominant_color,
+ read: [input_path],
+ write: [],
timeout:,
nice: 10,
)
@@ -28,35 +32,53 @@ module DiscourseVips
def self.svg_dimensions(input_path:, timeout:)
timeout = [timeout, SVG_DIMENSIONS_TIMEOUT_SECONDS].min
- Client.call(["svg-dimensions", input_path], operation: :upload_svg_dimensions, timeout:)
+ Client.call(
+ ["svg-dimensions", input_path],
+ operation: :upload_svg_dimensions,
+ timeout:,
+ read: [input_path],
+ write: [],
+ )
end
# Uses GIF/WebP frame counts and HEIF/AVIF image collections.
# APNG and timed HEIF/AVIF sequences are unsupported.
def self.animated?(input_path:, timeout:)
- Client.call(["animated", input_path], operation: :upload_animation_probe, timeout:)
+ Client.call(
+ ["animated", input_path],
+ operation: :upload_animation_probe,
+ timeout:,
+ read: [input_path],
+ write: [],
+ )
end
- def self.heif_to_jpeg(input_path:, output_path:, quality:, timeout:)
+ def self.heif_to_jpeg(input_path:, output_path:, quality:, timeout:, read:, write:)
Client.call(
["heif-to-jpeg", input_path, output_path, quality],
operation: :upload_heif_to_jpeg,
+ read:,
+ write:,
timeout:,
)
end
- def self.recompress_jpeg(input_path:, output_path:, quality:, timeout:)
+ def self.recompress_jpeg(input_path:, output_path:, quality:, timeout:, read:, write:)
Client.call(
["recompress-jpeg", input_path, output_path, quality],
operation: :upload_jpeg_recompression,
timeout:,
+ read:,
+ write:,
)
end
- def self.png_to_jpeg(input_path:, output_path:, quality:, timeout:)
+ def self.png_to_jpeg(input_path:, output_path:, quality:, timeout:, read:, write:)
Client.call(
["png-to-jpeg", input_path, output_path, quality],
operation: :upload_png_to_jpeg,
+ read:,
+ write:,
timeout:,
)
end
diff --git a/lib/discourse_vips/client.rb b/lib/discourse_vips/client.rb
index a362675f0d8..821a850b9b4 100644
--- a/lib/discourse_vips/client.rb
+++ b/lib/discourse_vips/client.rb
@@ -23,8 +23,8 @@ module DiscourseVips
reset_worker_process
end
- def self.call(command, operation:, timeout: DEFAULT_TIMEOUT_SECONDS, nice: nil)
- payload = { command: command.map(&:to_s), timeout:, nice: }
+ def self.call(command, operation:, timeout: DEFAULT_TIMEOUT_SECONDS, nice: nil, read:, write:)
+ payload = { command: command.map(&:to_s), timeout:, nice:, read:, write: }
ImageProcessing::Instrumentation.instrument(operation:) do
response = send_command(payload, timeout:)
diff --git a/lib/upload_creator.rb b/lib/upload_creator.rb
index 3186b0dc7d3..71eddb1a813 100644
--- a/lib/upload_creator.rb
+++ b/lib/upload_creator.rb
@@ -361,6 +361,8 @@ class UploadCreator
output_path: to,
quality: SiteSetting.image_quality,
timeout: MAX_CONVERT_FORMAT_SECONDS,
+ read:,
+ write:,
)
else
begin
@@ -655,6 +657,8 @@ class UploadCreator
output_path: to,
quality:,
timeout: MAX_CONVERT_FORMAT_SECONDS,
+ read: [from],
+ write: [File.dirname(to)],
)
else
from = OptimizedImage.prepend_decoder!(from, nil, filename: "image.#{@image_info.type}")
diff --git a/script/discourse_vips_worker b/script/discourse_vips_worker
index e3834f6b91a..38db55770e8 100644
--- a/script/discourse_vips_worker
+++ b/script/discourse_vips_worker
@@ -64,9 +64,7 @@ class DiscourseVipsWorker
end
end
- def initialize(read_paths: [], write_paths: [], rlimits: {}, &action)
- @read_paths = read_paths
- @write_paths = write_paths
+ def initialize(rlimits: {}, &action)
@rlimits = rlimits
@action = action
end
@@ -75,10 +73,10 @@ class DiscourseVipsWorker
@action.call
end
- def sandbox_paths(scratch:)
+ def sandbox_paths(scratch:, read:, write:)
{
- "read" => existing_paths([*DEFAULT_READ_PATHS, DYNAMIC_LINKER_CACHE_PATH, *@read_paths]),
- "write" => existing_paths([scratch, *@write_paths]),
+ "read" => existing_paths([*DEFAULT_READ_PATHS, DYNAMIC_LINKER_CACHE_PATH, *read]),
+ "write" => existing_paths([scratch, *write]),
}
end
@@ -92,10 +90,7 @@ class DiscourseVipsWorker
private_class_method :version
def self.letter_avatar(letter, output_path, background_color, font, font_path)
- new(
- read_paths: ["/etc/fonts", "/var/cache/fontconfig", font_path],
- write_paths: [File.dirname(output_path)],
- ) do
+ new do
if !letter || !output_path || !font_path
raise ArgumentError, "invalid letter avatar arguments"
end
@@ -116,7 +111,7 @@ class DiscourseVipsWorker
private_class_method :letter_avatar
def self.dominant_color(input_path)
- new(read_paths: [input_path]) do
+ new do
raise ArgumentError, "invalid dominant color arguments" if !input_path
block_loaders(
@@ -153,7 +148,7 @@ class DiscourseVipsWorker
private_class_method :dominant_color
def self.animated(input_path)
- new(read_paths: [input_path]) do
+ new do
block_loaders(allowed: %w[VipsForeignLoadNsgif VipsForeignLoadWebp VipsForeignLoadHeif])
begin
@@ -167,7 +162,7 @@ class DiscourseVipsWorker
private_class_method :animated
def self.heif_to_jpeg(input_path:, output_path:, quality:)
- new(read_paths: [input_path], write_paths: [File.dirname(output_path)]) do
+ new do
block_loaders(allowed: %w[VipsForeignLoadHeif])
begin
@@ -185,7 +180,7 @@ class DiscourseVipsWorker
private_class_method :heif_to_jpeg
def self.png_to_jpeg(input_path:, output_path:, quality:)
- new(read_paths: [input_path], write_paths: [File.dirname(output_path)]) do
+ new do
block_loaders(allowed: %w[VipsForeignLoadPng])
begin
@@ -198,7 +193,7 @@ class DiscourseVipsWorker
private_class_method :png_to_jpeg
def self.recompress_jpeg(input_path:, output_path:, quality:)
- new(read_paths: [input_path], write_paths: [File.dirname(output_path)]) do
+ new do
block_loaders(allowed: %w[VipsForeignLoadJpeg])
begin
@@ -229,7 +224,7 @@ class DiscourseVipsWorker
private_class_method :save_jpeg
def self.svg_dimensions(input_path)
- new(read_paths: [input_path], rlimits: SVG_DIMENSIONS_RLIMITS) do
+ new(rlimits: SVG_DIMENSIONS_RLIMITS) do
raise ArgumentError, "invalid SVG dimensions arguments" if !input_path
block_loaders(allowed: %w[VipsForeignLoadSvg])
@@ -363,7 +358,7 @@ class DiscourseVipsWorker
def run_sandboxed(request:, operation:)
Dir.mktmpdir("discourse-vips-") do |scratch|
- sandbox_paths = operation.sandbox_paths(scratch:)
+ sandbox_paths = operation.sandbox_paths(scratch:, read: request.fetch("read"), write: request.fetch("write"))
result =
Landlock.fork(
read: sandbox_paths.fetch("read"),
diff --git a/spec/lib/discourse_vips_spec.rb b/spec/lib/discourse_vips_spec.rb
index 32ba553ec38..011dfbebccf 100644
--- a/spec/lib/discourse_vips_spec.rb
+++ b/spec/lib/discourse_vips_spec.rb
@@ -15,6 +15,8 @@ RSpec.describe DiscourseVips do
output_path: File.join(directory, "output.jpg"),
quality: SiteSetting.image_quality,
timeout: 20,
+ read: [input_path],
+ write: [File.dirname(File.join(directory, "output.jpg"))],
)
end
@@ -126,6 +128,8 @@ RSpec.describe DiscourseVips do
output_path:,
quality: SiteSetting.image_quality,
timeout: 20,
+ read: [input_path],
+ write: [File.dirname(output_path)],
)
expect(FastImage.type(output_path)).to eq(:jpeg)
@@ -155,6 +159,8 @@ RSpec.describe DiscourseVips do
output_path:,
quality: SiteSetting.image_quality,
timeout: 20,
+ read: [input_path],
+ write: [File.dirname(output_path)],
)
expect(FastImage.type(output_path)).to eq(:jpeg)
@@ -175,12 +181,16 @@ RSpec.describe DiscourseVips do
output_path: lower_quality_path,
quality: 40,
timeout: 20,
+ read: [input_path],
+ write: [File.dirname(lower_quality_path)],
)
described_class.heif_to_jpeg(
input_path:,
output_path: higher_quality_path,
quality: 95,
timeout: 20,
+ read: [input_path],
+ write: [File.dirname(higher_quality_path)],
)
expect(File.size(lower_quality_path)).to be < File.size(higher_quality_path)
@@ -200,6 +210,8 @@ RSpec.describe DiscourseVips do
output_path:,
quality: SiteSetting.image_quality,
timeout: 20,
+ read: [input_path],
+ write: [File.dirname(output_path)],
)
}.to raise_error(DiscourseVips::InvalidImage)
@@ -221,6 +233,8 @@ RSpec.describe DiscourseVips do
output_path: input_path,
quality: SiteSetting.image_quality,
timeout: 20,
+ read: [input_path],
+ write: [File.dirname(input_path)],
)
}.to raise_error(
DiscourseVips::Error,
@@ -244,6 +258,8 @@ RSpec.describe DiscourseVips do
output_path:,
quality: SiteSetting.image_quality,
timeout: 0.05,
+ read: [input_path],
+ write: [File.dirname(output_path)],
)
}.to raise_error(DiscourseVips::OperationTimeout)
end
@@ -388,11 +404,15 @@ RSpec.describe DiscourseVips do
Dir.mktmpdir do |directory|
output_path = File.join(directory, "converted.jpg")
+ input_path = file_from_fixtures("dominant-color-transparent.png").path
+
described_class.png_to_jpeg(
- input_path: file_from_fixtures("dominant-color-transparent.png").path,
+ input_path:,
output_path:,
quality: SiteSetting.ImageQuality.png_to_jpg_quality,
timeout: 5,
+ read: [input_path],
+ write: [File.dirname(output_path)],
)
expect(FastImage.type(output_path)).to eq(:jpeg)
@@ -404,12 +424,16 @@ RSpec.describe DiscourseVips do
Dir.mktmpdir do |directory|
output_path = File.join(directory, "converted.jpg")
+ input_path = file_from_fixtures("logo.jpg").path
+
expect {
described_class.png_to_jpeg(
- input_path: file_from_fixtures("logo.jpg").path,
+ input_path:,
output_path:,
quality: SiteSetting.ImageQuality.png_to_jpg_quality,
timeout: 5,
+ read: [input_path],
+ write: [File.dirname(output_path)],
)
}.to raise_error(DiscourseVips::InvalidImage)
expect(File.exist?(output_path)).to eq(false)
@@ -428,7 +452,14 @@ RSpec.describe DiscourseVips do
output_path = File.join(directory, "converted.jpg")
input_path = file_from_fixtures("logo.jpg").path
- described_class.recompress_jpeg(input_path:, output_path:, quality: 40, timeout: 5)
+ described_class.recompress_jpeg(
+ input_path:,
+ output_path:,
+ quality: 40,
+ timeout: 5,
+ read: [input_path],
+ write: [File.dirname(output_path)],
+ )
expect(FastImage.type(output_path)).to eq(:jpeg)
expect(FastImage.size(output_path)).to eq(FastImage.size(input_path))
@@ -438,6 +469,8 @@ RSpec.describe DiscourseVips do
output_path: higher_quality_path,
quality: 95,
timeout: 5,
+ read: [input_path],
+ write: [File.dirname(higher_quality_path)],
)
expect(File.size(output_path)).to be < File.size(higher_quality_path)
end
@@ -455,6 +488,8 @@ RSpec.describe DiscourseVips do
output_path: input_path,
quality: 40,
timeout: 5,
+ read: [input_path],
+ write: [File.dirname(input_path)],
)
}.to raise_error(DiscourseVips::Error, /separate input and output/)
expect(File.binread(input_path)).to eq(original)