mxc 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 988895e92e027354db083acc4b7fefd8b48d6ac8a5e4bfed22a734f4c020dd3d
-  data.tar.gz: 4d014ede1e4b3c35551304d1b92fdf49889587b009bb0fb0df39c96fb8718926
+  metadata.gz: fccd6da3c4cef2c5422949e1a28b2c38fad41a709a33db744e95c255e32c72fa
+  data.tar.gz: 165b13bffc2f44b45468a215647b054413acb392aed297d8f9325a8e9f38d707
 SHA512:
-  metadata.gz: f9330fd9f89ad26e9ce2494969b6734afb4fdb3f6e4a8f3712421e1d5f28d0e4efbc40965520a6ed3c0211b7ccf2c915fd74b05daed107ef02168e9b4b5f18f1
-  data.tar.gz: 44a17cc95d03e7a24b2fe2cc71fb32137c2983f01c155dbd2a9e1fb0051bd9193e3c22754acdbe050881ec0a3f64f0fcb4b2e131d09c13e4ea02038fc2fa4ed0
+  metadata.gz: c8296fcb1dacf6434405b6e821a88f69871dc3877f05c3fa04e9140017f564aa773f43276812e9954a09335022732e20b4b88159ce63d4eca6ff58d5cea9281a
+  data.tar.gz: 9908ebc2252e66cf4d06e4d23c07fd2975943d60aa4b629c0e6b1127f0c690acbc2eab8a5955ed7bb6ec71fc803d30a82d3fb5aefe398f65a9720eb210ae897e

data/Cargo.lock

@@ -593,7 +593,7 @@ dependencies = [
 
 [[package]]
 name = "mxc"
-version = "0.3.0"
+version = "0.4.0"
 dependencies = [
  "magnus",
  "mxc-sdk",

data/ext/mxc/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mxc"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2021"
 authors = ["Carmine Paolino <carmine@paolino.me>"]
 license = "MIT"

data/lib/mxc/libraries.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'shellwords'
+
+module MXC
+  # Finds the shared library files programs load, directly or through
+  # other libraries, so a sandbox can read them and nothing beside them. Only macOS needs this: Seatbelt
+  # sandboxes read the system's libraries but not those a package manager
+  # installs, such as Homebrew's, which a program like Ruby may link. The
+  # libraries come from the programs' load commands, read with otool from
+  # the Command Line Tools. Without them nothing is found, because
+  # /usr/bin/otool would offer to install them instead.
+  module Libraries # :nodoc:
+    OTOOL = '/usr/bin/otool'
+    XCODE_SELECT = '/usr/bin/xcode-select'
+    SYSTEM = %w[/usr/lib/ /System/ /Library/].freeze
+    TOKEN = %r{\A@(loader_path|executable_path|rpath)/}
+
+    @links = {}
+    @lock = Mutex.new
+
+    class << self
+      # Returns the real paths of the library files +binaries+ load outside
+      # the system's own, empty where none are needed or otool is missing.
+      # +executable+ is the program that loads them, for libraries named
+      # relative to it.
+      def files(binaries, executable: nil)
+        return [] if binaries.empty? || !available?
+
+        libraries(binaries, executable)
+      end
+
+      # Returns the path of the program +arguments+ start: the first argument, or the first
+      # word of a command for the shell, found on +path+ or under +directory+. Returns nil
+      # when there is none.
+      def program(arguments, path:, directory:)
+        name = program_name(arguments)
+        return if name.nil?
+        return File.expand_path(name, directory || '/') if name.include?('/')
+
+        path.to_s.split(File::PATH_SEPARATOR).map { |entry| File.join(entry, name) }
+            .find { |candidate| File.file?(candidate) && File.executable?(candidate) }
+      end
+
+      # Returns true when this host can list a program's libraries.
+      def available?
+        return @available if defined?(@available)
+
+        @available = RUBY_PLATFORM.include?('darwin') && File.executable?(OTOOL) && developer_tools?
+      end
+
+      private
+
+      def program_name(arguments)
+        arguments.one? ? Shellwords.split(arguments.first).first : arguments.first
+      rescue ArgumentError
+        nil
+      end
+
+      def libraries(binaries, executable)
+        roots = binaries.filter_map { |binary| real_path(binary) }
+        links_of(roots)
+        found = {}
+        roots.each { |root| visit(root, executable || root, [], found) }
+        found.keys
+      end
+
+      def visit(path, executable, inherited, found)
+        dependencies(path, links_of([path]).fetch(path), executable, inherited).each do |library, rpaths|
+          next if found.key?(library)
+
+          found[library] = true
+          visit(library, executable, rpaths, found)
+        end
+      end
+
+      def developer_tools?
+        system(XCODE_SELECT, '-p', out: File::NULL, err: File::NULL) == true
+      end
+
+      def dependencies(path, links, executable, inherited)
+        rpaths = links[:rpaths].filter_map { |rpath| expand(rpath, path, executable) } + inherited
+        links[:libraries].filter_map do |name|
+          next if system?(name)
+
+          library = locate(name, path, executable, rpaths)
+          [library, rpaths] if library && !system?(library)
+        end
+      end
+
+      def locate(name, loader, executable, rpaths)
+        relative = name.delete_prefix('@rpath/')
+        candidates = if relative == name
+                       [expand(name, loader, executable)]
+                     else
+                       rpaths.map { |rpath| File.join(rpath, relative) }
+                     end
+        candidates.compact.lazy.filter_map { |candidate| real_path(candidate) }.first
+      end
+
+      def expand(name, loader, executable)
+        token = name[TOKEN, 1]
+        return name unless token
+        return if token == 'rpath'
+
+        base = token == 'loader_path' ? loader : executable
+        File.expand_path(name.sub(TOKEN, ''), File.dirname(base))
+      end
+
+      def system?(path)
+        path.start_with?(*SYSTEM)
+      end
+
+      def real_path(path)
+        path = File.realpath(path)
+        path if File.file?(path)
+      rescue SystemCallError
+        nil
+      end
+
+      def links_of(paths)
+        @lock.synchronize do
+          missing = paths.reject { |path| @links.key?(path) }
+          @links.merge!(LoadCommands.parse(otool(missing), missing)) if missing.any?
+          @links.slice(*paths)
+        end
+      end
+
+      def otool(paths)
+        output, = Open3.capture2(OTOOL, '-l', *paths, err: File::NULL)
+        output
+      rescue SystemCallError
+        ''
+      end
+    end
+  end
+end

data/lib/mxc/load_commands.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module MXC
+  # Reads the libraries and run paths of Mach-O files from the load
+  # commands <tt>otool -l</tt> lists, with every architecture of a
+  # universal file together.
+  module LoadCommands # :nodoc:
+    LOAD = /\A\s*cmd LC_(?:LOAD_DYLIB|LOAD_WEAK_DYLIB|REEXPORT_DYLIB|LAZY_LOAD_DYLIB|LOAD_UPWARD_DYLIB)\z/
+    RPATH = /\A\s*cmd LC_RPATH\z/
+    COMMAND = /\A\s*cmd /
+    VALUE = /\A\s*(?:name|path) (.+) \(offset \d+\)\z/
+    ARCHITECTURE = / \(architecture [^)]+\)\z/
+
+    class << self
+      # Returns, for each of +paths+, the install names of the libraries it
+      # loads and its run paths, as <tt>{ libraries: [...], rpaths: [...] }</tt>.
+      def parse(output, paths)
+        links = paths.to_h { |path| [path, { libraries: [], rpaths: [] }] }
+        current = kind = nil
+        output.each_line(chomp: true) do |line|
+          if links.key?(header = header_path(line))
+            current = links[header]
+            kind = nil
+          elsif current
+            kind = record(current, kind, line)
+          end
+        end
+        links
+      end
+
+      private
+
+      def record(links, kind, line)
+        return :libraries if line.match?(LOAD)
+        return :rpaths if line.match?(RPATH)
+        return if line.match?(COMMAND)
+
+        value = line[VALUE, 1] if kind
+        return kind unless value
+
+        links[kind] << value
+        nil
+      end
+
+      def header_path(line)
+        line.delete_suffix(':').sub(ARCHITECTURE, '') if line.end_with?(':') && !line.start_with?(' ', "\t")
+      end
+    end
+  end
+end

data/lib/mxc/sandbox.rb

@@ -30,7 +30,8 @@ module MXC
   class Sandbox
     BACKENDS = %i[auto bubblewrap landlock seatbelt process_container].freeze # :nodoc:
     LANDLOCK_FALLBACK = /runs on Landlock instead/ # :nodoc:
-    OPTIONS = %i[readable writable denied network env directory timeout backend limits priority].freeze # :nodoc:
+    OPTIONS = %i[readable writable denied libraries libraries_of network env directory timeout backend limits
+                 priority].freeze # :nodoc:
     HOST_RESOLVER_SOCKETS = %w[/run/systemd/resolve].freeze # :nodoc:
     WINDOWS_ENV = %w[SYSTEMROOT WINDIR SYSTEMDRIVE COMSPEC PATHEXT PATH LOCALAPPDATA TEMP TMP
                      PROCESSOR_ARCHITECTURE NUMBER_OF_PROCESSORS OS].freeze # :nodoc:
@@ -40,8 +41,8 @@ module MXC
     PRIORITIES = { normal: nil, low: 'low', lowest: 'idle' }.freeze # :nodoc:
     MEGABYTE = 1024 * 1024 # :nodoc:
     DEFAULTS = {
-      readable: [], writable: [], denied: [], env: {}, network: false, directory: nil, timeout: nil, backend: nil,
-      limits: {}, priority: nil
+      readable: [], writable: [], denied: [], libraries: true, libraries_of: [], env: {}, network: false,
+      directory: nil, timeout: nil, backend: nil, limits: {}, priority: nil
     }.freeze # :nodoc:
 
     class << self
@@ -54,6 +55,13 @@ module MXC
       # Adds paths every instance hides, even inside readable or writable paths.
       def denied(*paths) = configure { |sandbox| sandbox.with_denied(*paths) }
 
+      # Adds programs and libraries whose shared libraries every instance can load.
+      # Takes the same arguments as #with_libraries_of.
+      def libraries_of(*paths) = configure { |sandbox| sandbox.with_libraries_of(*paths) }
+
+      # Sets whether every instance can read the libraries its programs load. See #with_libraries.
+      def libraries(enabled) = configure { |sandbox| sandbox.with_libraries(enabled) }
+
       # Sets every instance's network access. Takes the same arguments as #with_network.
       def network(...) = configure { |sandbox| sandbox.with_network(...) }
 
@@ -135,6 +143,12 @@ module MXC
     # Returns the paths hidden from the command, as given.
     def denied = @settings[:denied].dup.freeze
 
+    # Returns the programs and libraries whose shared libraries the command can load, as given.
+    def libraries_of = @settings[:libraries_of].dup.freeze
+
+    # Returns true when the command can read the libraries its program loads, the default.
+    def libraries = @settings[:libraries]
+
     # Returns the environment variables set for the command.
     def env = @settings[:env].dup.freeze
 
@@ -173,6 +187,32 @@ module MXC
       add_paths(:denied, paths)
     end
 
+    # Adds programs and libraries whose shared libraries the command loads, such as the
+    # extensions an interpreter opens. On macOS, the command can read those library files,
+    # and the libraries they load in turn, when they are not the system's own. The program
+    # the command runs needs no entry: #run grants its libraries already. Elsewhere, on a
+    # Mac without the Command Line Tools, and with <tt>with_libraries(false)</tt>, this
+    # grants nothing.
+    #
+    #   sandbox.with_libraries_of(*Dir[File.join(RbConfig::CONFIG["archdir"], "**", "*.bundle")])
+    def with_libraries_of(*paths)
+      add_paths(:libraries_of, paths)
+    end
+
+    # Sets whether the command can read the shared libraries its program and #libraries_of
+    # load, on macOS. +true+ is the default; +false+ grants no library, so the command reads
+    # only the system's and those under #readable. +nil+ resets it to +true+.
+    #
+    #   sandbox.with_libraries(false)
+    def with_libraries(enabled)
+      unless [true, false, nil].include?(enabled)
+        raise ArgumentError, "libraries must be true, false or nil, got #{enabled.inspect}"
+      end
+
+      @settings[:libraries] = enabled != false
+      self
+    end
+
     # Sets network access. The default, +false+, gives the command no network at all.
     # +true+ allows any destination. <tt>allow:</tt> takes a list of hosts the command
     # may reach over HTTP and HTTPS: <tt>"pypi.org"</tt>, <tt>"*.pythonhosted.org"</tt>
@@ -273,6 +313,12 @@ module MXC
     #
     # With a block, yields each Chunk of output as it arrives.
     #
+    # On macOS, the command can read the shared library files its program links outside
+    # the system's own, such as Homebrew's, so programs built against them start. The
+    # program is the first argument, or the first word of a command for the shell, found
+    # on the +PATH+ of #env. See #with_libraries_of for libraries the program opens later,
+    # and #with_libraries to turn this off.
+    #
     #   sandbox.run("python3 build.py && ls dist")
     #   sandbox.run("python3", "convert.py", params[:filename])
     #   sandbox.run("python3", "build.py") { |chunk| print chunk.content }
@@ -283,7 +329,8 @@ module MXC
     def run(*command, &)
       return stream(*command, &) if block_given?
 
-      outcome = StartupFailure.check!(Native.run(command_line(command), request))
+      arguments = command_arguments(command)
+      outcome = StartupFailure.check!(Native.run(command_line(arguments), request(arguments)))
       Result.new(**outcome, backend: resolved_backend(outcome[:warnings]))
     end
 
@@ -292,7 +339,8 @@ module MXC
     #
     #   sandbox.spawn("python3", "-i", "-q")
     def spawn(*command)
-      native = Native.spawn(command_line(command), request)
+      arguments = command_arguments(command)
+      native = Native.spawn(command_line(arguments), request(arguments))
       Process.new(native, backend: resolved_backend(native.warnings))
     end
 
@@ -315,7 +363,8 @@ module MXC
     def inspect # :nodoc:
       resources = " limits=#{limits.inspect} priority=#{priority.inspect}" if self.resources
       "#<#{self.class.name || 'MXC::Sandbox'} backend=#{backend.inspect} network=#{network.inspect} " \
-        "readable=#{readable.inspect} writable=#{writable.inspect} timeout=#{timeout.inspect}#{resources}>"
+        "readable=#{readable.inspect} writable=#{writable.inspect} timeout=#{timeout.inspect}#{resources}" \
+        "#{libraries_inspect}>"
     end
 
     protected
@@ -330,7 +379,7 @@ module MXC
 
     def apply(name, value)
       case name
-      when :readable, :writable, :denied then public_send(:"with_#{name}", *Array(value))
+      when :readable, :writable, :denied, :libraries_of then public_send(:"with_#{name}", *Array(value))
       when :network then value.is_a?(Hash) ? with_network(**value) : with_network(value)
       when :limits then value.nil? ? with_limits(nil) : with_limits(**value)
       else public_send(:"with_#{name}", value)
@@ -384,8 +433,7 @@ module MXC
       process&.kill unless finished
     end
 
-    def command_line(command)
-      arguments = command_arguments(command)
+    def command_line(arguments)
       return command_line_for_windows(arguments) if Preflight.windows?
 
       arguments.one? ? arguments.first : Shellwords.join(arguments)
@@ -420,10 +468,10 @@ module MXC
       warnings.any?(LANDLOCK_FALLBACK) ? :landlock : :bubblewrap
     end
 
-    def request
+    def request(arguments)
       Preflight.check!(network:, denied:, resources:, backend:)
       {
-        readonly: expand(readable),
+        readonly: expand(readable) | library_files(arguments),
         readwrite: expand(writable),
         denied: expand(denied) | hidden_resolver_sockets,
         environment:,
@@ -474,6 +522,17 @@ module MXC
       system.reject { |name, _| env.keys.any? { |own| own.casecmp?(name) } }.merge(env)
     end
 
+    def libraries_inspect
+      libraries ? (" libraries_of=#{libraries_of.inspect}" if libraries_of.any?) : ' libraries=false'
+    end
+
+    def library_files(arguments)
+      return [] unless libraries && Libraries.available?
+
+      program = Libraries.program(arguments, path: env['PATH'], directory: working_directory)
+      Libraries.files([*program, *expand(libraries_of)], executable: program)
+    end
+
     def hidden_resolver_sockets
       return [] if network == true
 

data/lib/mxc/version.rb

@@ -2,5 +2,5 @@
 
 module MXC
   # The gem version.
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/mxc.rb

@@ -12,6 +12,8 @@ require 'mxc/backend'
 require 'mxc/availability'
 require 'mxc/process'
 require 'mxc/windows_arguments'
+require 'mxc/load_commands'
+require 'mxc/libraries'
 require 'mxc/sandbox'
 
 # Runs commands in sandboxes through Microsoft's MXC.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Carmine Paolino
@@ -49,6 +49,8 @@ files:
 - lib/mxc/chunk.rb
 - lib/mxc/configuration.rb
 - lib/mxc/error.rb
+- lib/mxc/libraries.rb
+- lib/mxc/load_commands.rb
 - lib/mxc/native.rb
 - lib/mxc/preflight.rb
 - lib/mxc/process.rb