bwrap 1.0.0.pre.alpha2 → 1.0.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd1c029789733da3f76f30e1de8647ae2844ee70e7b3558944c9fda0e8c48cdd
-  data.tar.gz: b2a46db9002fd1c9699ab4d763d1e98105c69539b1fcd05afeb9a9c887fe09f7
+  metadata.gz: db6e7253c0a896975954c0d649c68321958ade750f891f353ba30b9ea58880cb
+  data.tar.gz: 90f384499e8727660b9810711e0237ce604f8ef219ed415c210db16bcd764804
 SHA512:
-  metadata.gz: 375d76049c7654c40258892a1d3a3e6d062ad80c75402560be71298572c58d5284151966c5b388c16f836999daea732d39fa1ab91a31f9ebd925476ef198fd75
-  data.tar.gz: 0e31779606b0f8add41c8ff2c1420a39bfe84cad10dae64c1107161791a404569797c89ed3b8401c0976002203a025f078f603d145c7e9673d037e29cb0d5a0d
+  metadata.gz: 03e6873b068e52bc0c9fbbc072f9fc1a411696ca3c09aabcee05c8e660e5a210030c13fab84348aee720e7bd431600a0b18c3be124dfcb955ac95c250d83aeec
+  data.tar.gz: 4183575c47d740dd74c88995add7b87366299e75b4a8edaa89c20d422cd73cbd957b411e5bd51b9c9eabcd3881d8af1ba85922ce806b2387d75a0f30d8abd377

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changes
 
+## 1.0.0-beta1 (12.12.2021)
+
+* optimist gem is now optional dependency
+* Added Config#env_paths and Config#add_env_path
+* Added Config#command_inside_root
+* Added Bwrap#run_inside_root convenience method
+* Execution#command_available?: added env_path_var argument
+* Execution#which: added env_path_var argument
+* Be able to resolve /usr/bin/env to real executable
+* Try to avoid duplicate library binds
+* Added Config#extra_executables
+* Added Config::Features::Bash
+
+## 1.0.0-alpha5 (29.11.2021)
+
+* Execution#command_available?: support absolute paths
+* Execution#which: support absolute paths
+* Many miscellaneous fixes
+
+## 1.0.0-alpha4 (22.11.2021)
+
+* Allow use without home directory set
+* Bwrap#parse_command_line_arguments is no longer run when Bwrap is initialized
+* Made pulseaudio optional
+* Changed --share-net to be added only if requested
+* Added Config#root= to specify path used as writable root
+* Added Config#full_system_mounts to control whether library loaders are mounted inside chroot
+* Added Config#libdir_mounts
+* Added Config#features
+
+## 1.0.0-alpha3 (14.11.2021)
+
+* Avoid frozen string literal modification
+
 ## 1.0.0-alpha2 (14.11.2021)
 
 * Made gem to tell its license (ISC)

data/README.md

@@ -31,3 +31,5 @@ Please see [API documentation](https://www.rubydoc.info/gems/bwrap) for usage in
 ## Contributing
 
 Bug reports and pull requests are welcome at https://git.sr.ht/~smar/ruby-bwrap.
+
+Gerrit instance https://gerrit.smar.fi/admin/repos/ruby-bwrap can also be used.

data/lib/bwrap/args/args.rb

@@ -2,7 +2,11 @@
 
 require "bwrap/version"
 
-# bwrap argument related operations.
+# Classes that are used for building arguments.
+#
+# @note Classes inside here are kind of pseudo-internal API.
+#   In future, there may be some use for classes inside here, but for now they are
+#   only used internally.
 module Bwrap::Args
   # Nya.
 end

data/lib/bwrap/args/bind/library.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "bwrap/execution/path"
+require "bwrap/output"
+require_relative "../library"
+require_relative "mime"
+
+class Bwrap::Args::Bind
+  # TODO: documentation
+  #
+  # @api private
+  class Library
+    include Bwrap::Execution::Path
+    include Bwrap::Output
+
+    # @see Bwrap::Args::Construct#command=
+    #
+    # @see (see Bwrap::Args::Construct#command=)
+    attr_writer :command
+
+    # Instance of {Bwrap::Config}.
+    attr_writer :config
+
+    # Instance of {Bwrap::Args::Environment}.
+    attr_writer :environment
+
+    attr_writer :executable_name
+
+    attr_writer :executable_path
+
+    def initialize args
+      @args = args
+    end
+
+    def extra_executables_mounts
+      return unless @config&.extra_executables
+
+      @config.extra_executables.each do |executable|
+        @executable_name = resolve_executable_name executable
+        @executable_path = resolve_executable_path @executable_name, not_inside_root: true
+
+        @args.append %W{ --ro-bind #{@executable_path} #{@executable_path} }
+
+        resolve_executable_libraries
+      end
+    end
+
+    # Convenience method to call {#resolve_executable_libraries}.
+    #
+    # Used by {#handle_system_mounts}.
+    def libs_command_requires
+      @executable_name = resolve_executable_name @command
+      @executable_path = resolve_executable_path @executable_name
+
+      # Actually add the executable to be bound to the sandbox.
+      unless @config&.command_inside_root
+        @args.append %W{ --ro-bind #{@executable_path} #{@executable_path} }
+      end
+
+      resolve_executable_libraries
+    end
+
+    # Does some inspection to find out libraries given executable needs in order to work.
+    #
+    # @warning scanelf does not play with spaces in names well. This method assumes that libraries
+    #   have no spaces in names, though binaries can have.
+    #
+    # @todo Ensure scanelf is available (and throw proper error if it is not, telling to not use
+    #   full_system_mounts option.)
+    def resolve_executable_libraries
+      trace "Resolving executable libraries of #{@executable_path}"
+
+      # TODO: Put this behind additional flag for extra control/sanity.
+      # Some executables are shell scripts and similar. For them we need to use the interpreter.
+
+      mime = Mime.new @executable_name, @executable_path
+      return unless mime.resolve_mime_type
+
+      # Then find out required libraries
+
+      library_mounts = []
+
+      library_object = ::Bwrap::Args::Library.new
+      libraries = library_object.libraries_needed_by mime.executable_path
+
+      # TODO: following is bad?
+      #library_object.needed_libraries(mime.executable_path).each do |library|
+      libraries.each do |library|
+        library_mounts << "--ro-bind" << library << library
+      end
+
+      @args.append library_mounts
+    end
+
+    # Used by {#libs_command_requires}.
+    private def resolve_executable_name command
+      if command.is_a? String
+        return command
+      end
+
+      # Array-like.
+      if command.respond_to? :at
+        return command.at(0)
+      end
+
+      raise "Can’t recognize type of given command. Type: #{command.class}"
+    end
+
+    # @warning Requires environment paths to be resolved beforehand.
+    #
+    # Used by {#libs_command_requires}.
+    private def resolve_executable_path executable_name, not_inside_root: nil
+      if @config&.command_inside_root.nil? or not_inside_root
+        return which executable_name
+      end
+
+      paths = @environment.env_paths.map do |path|
+        "#{@config.root}/#{path}"
+      end
+      env_path = paths.join ":"
+
+      which executable_name, env_path_var: env_path
+    end
+  end
+end

data/lib/bwrap/args/bind/mime.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "bwrap/execution"
+require "bwrap/output"
+
+class Bwrap::Args::Bind
+  # Inner class to clean up namespace for implementation specific reasons.
+  #
+  # @api private
+  class Mime
+    include Bwrap::Execution
+    include Bwrap::Output
+
+    # Name given to {#initialize}.
+    attr_reader :executable_name
+
+    # Either path given to {#initialize} or one parsed from shebang.
+    attr_reader :executable_path
+
+    def initialize executable_name, executable_path
+      @executable_name = executable_name
+      @executable_path = executable_path
+    end
+
+    # Used by {Bwrap::Args::Bind::Library#libs_command_requires}.
+    #
+    # @return false if caller should also return
+    def resolve_mime_type
+      mime_type = execvalue %W{ file --brief --mime-type #{@executable_path} }
+      trace "Mime type of #{@executable_path} is #{mime_type}"
+      return true unless mime_type[0..6] == "text/x-"
+
+      shebang = File.open @executable_path, &:readline
+      if shebang[0..1] != "#!"
+        warn "Executable #{@executable_name} was recognized as #{mime_type} but does not have " \
+             "proper shebang line. Skipping automatic library mounts."
+        return false
+      end
+
+      resolve_real_executable shebang
+
+      true
+    end
+
+    private def resolve_real_executable shebang
+      command_line = shebang.delete_prefix("#!").strip
+      real_executable, args = command_line.split " ", 2
+
+      if [ "/usr/bin/env", "/bin/env" ].include? real_executable
+        # First argument is name of the executable, resolved from PATH.
+        executable_name = args.split(" ", 2).first
+        real_executable = which executable_name
+      end
+
+      @executable_path = real_executable
+    end
+  end
+end

data/lib/bwrap/args/bind.rb

@@ -1,32 +1,50 @@
 # frozen_string_literal: true
 
+require "bwrap/execution"
+require "bwrap/output"
 require_relative "args"
+require_relative "bind/library"
 
 # Bind arguments for bwrap.
-module Bwrap::Args::Bind
+class Bwrap::Args::Bind
+  include Bwrap::Execution
+  include Bwrap::Output
+
+  # Array of parameters passed to bwrap.
+  attr_writer :args
+
+  # @see Bwrap::Args::Construct#command=
+  #
+  # @see (see Bwrap::Args::Construct#command=)
+  attr_writer :command
+
+  # Instance of {Bwrap::Config}.
+  attr_writer :config
+
+  # Instance of {Bwrap::Args::Environment}.
+  attr_writer :environment
+
   # Arguments to bind /dev/dri from host to sandbox.
-  private def bind_dev_dri
-    %w{ --dev-bind /dev/dri /dev/dri }
+  def bind_dev_dri
+    @args.append %w{ --dev-bind /dev/dri /dev/dri }
   end
 
   # Arguments to bind /sys/dev/char from host to sandbox.
-  private def bind_sys_dev_char
-    %w{ --ro-bind /sys/dev/char /sys/dev/char }
+  def bind_sys_dev_char
+    @args.append %w{ --ro-bind /sys/dev/char /sys/dev/char }
   end
 
   # Arguments to bind /sys/devices/pci0000:00 from host to sandbox.
-  private def bind_pci_devices
-    %w{ --ro-bind /sys/devices/pci0000:00 /sys/devices/pci0000:00 }
+  def bind_pci_devices
+    @args.append %w{ --ro-bind /sys/devices/pci0000:00 /sys/devices/pci0000:00 }
   end
 
   # Arguments to bind home directory from sandbox directory (`#{@config.sandbox_directory}/home`)
   # as `/home/#{@config.user}`.
   #
   # @note Requires @config.user to be set.
-  private def bind_home_directory
-    unless @config.user
-      raise "Tried to bind user directory without user being set."
-    end
+  def bind_home_directory
+    return unless @config.user
 
     home_directory = "#{@config.sandbox_directory}/home"
 
@@ -36,43 +54,81 @@ module Bwrap::Args::Bind
 
     @environment["HOME"] = "/home/#{@config.user}"
 
-    %W{ --bind #{home_directory} /home/#{@config.user} }
+    debug "Using #{home_directory} as /home/#{@config.user}"
+    @args.append %W{ --bind #{home_directory} /home/#{@config.user} }
   end
 
   # Arguments to read-only bind whole system inside sandbox.
-  private def full_system_mounts
+  def handle_system_mounts
     bindir_mounts = []
     binaries_from = @config.binaries_from
     binaries_from.each do |path|
       bindir_mounts << "--ro-bind" << path << path
     end
-    @environment["PATH"] = binaries_from.join(":")
+    @environment.add_to_path binaries_from
 
-    libdir_mounts = %w{
-      --ro-bind /lib /lib
-      --ro-bind /lib64 /lib64
-      --ro-bind /usr/lib /usr/lib
-      --ro-bind /usr/lib64 /usr/lib64
-    }
+    @args.append bindir_mounts
 
-    system_mounts = bindir_mounts + libdir_mounts
     if debug?
-      debug "Using following system mounts:\n" \
-            "#{system_mounts}\n" \
+      debug "Using following bindir mounts:\n" \
+            "#{bindir_mounts}\n" \
             "(Odd is key, even is value)"
     end
-    system_mounts
+
+    libdir_mounts
+
+    library_bind = construct_library_bind
+
+    library_bind.extra_executables_mounts
+
+    return unless @config.full_system_mounts
+
+    library_bind.libs_command_requires
   end
 
   # These are something user can specify to do custom --ro-bind binds.
-  private def custom_read_only_binds
-    return [] unless @config.ro_binds
+  def custom_read_only_binds
+    return unless @config.ro_binds
 
     binds = []
     @config.ro_binds.each do |source_path, destination_path|
       binds << "--ro-bind" << source_path.to_s << destination_path.to_s
     end
 
-    binds
+    @args.append binds
+  end
+
+  # Performs cleanup operations after execution.
+  def cleanup
+    Bwrap::Args::Library.clear_needed_libraries_cache
+  end
+
+  # Used by {#handle_system_mounts}.
+  private def libdir_mounts
+    return unless @config.libdir_mounts
+
+    libdir_mounts = %w{
+      --ro-bind /lib /lib
+      --ro-bind /lib64 /lib64
+      --ro-bind /usr/lib /usr/lib
+      --ro-bind /usr/lib64 /usr/lib64
+    }
+
+    if debug?
+      debug "Using following libdir mounts:\n" \
+            "#{libdir_mounts}\n" \
+            "(Odd is key, even is value)"
+    end
+
+    @args.append libdir_mounts
+  end
+
+  private def construct_library_bind
+    library_bind = Bwrap::Args::Bind::Library.new @args
+    library_bind.command = @command
+    library_bind.config = @config
+    library_bind.environment = @environment
+
+    library_bind
   end
-end
+end

data/lib/bwrap/args/construct.rb

@@ -5,60 +5,90 @@ require "tempfile"
 require "bwrap/output"
 require_relative "bind"
 require_relative "environment"
+require_relative "features"
 require_relative "machine_id"
 require_relative "mount"
 
 # Constructs arguments for bwrap execution.
 class Bwrap::Args::Construct
   include Bwrap::Output
-  include Bwrap::Args::Bind
   include Bwrap::Args::Mount
 
   attr_writer :config
 
+  # Command that is executed inside bwrap sandbox.
+  #
+  # @note This is not used for anything vital, but some things, like
+  #   setting {Config#full_system_mounts=} uses this to resolve some
+  #   additional data.
+  #
+  # @param value [Array, String] Command with arguments
+  attr_writer :command
+
   # Constructs arguments for bwrap execution.
   def construct_bwrap_args
-    @environment = Bwrap::Args::Environment.new
-    @environment.config = @config
-    @machine_id = Bwrap::Args::MachineId.new
-    @machine_id.config = @config
-
-    [
-      xauthority_args,
-      @machine_id.machine_id,
-      resolv_conf,
-      full_system_mounts,
-      custom_read_only_binds,
-      create_user_dir,
-      read_only_pulseaudio,
-      dev_mount,
-      bind_dev_dri,
-      bind_sys_dev_char,
-      bind_pci_devices,
-      proc_mount,
-      tmp_as_tmpfs,
-      bind_home_directory,
-      "--unshare-all",
-      share_net,
-      hostname,
-      @environment.environment_variables,
-      "--die-with-parent",
-      "--new-session"
-    ]
+    @args = []
+    create_objects
+
+    root_mount
+    xauthority_args
+    machine_id = @machine_id.machine_id
+    @args.append machine_id if machine_id
+    resolv_conf
+    @bind.handle_system_mounts
+    @features.feature_binds
+    @bind.custom_read_only_binds
+    create_user_dir
+    read_only_pulseaudio
+    dev_mount
+    @bind.bind_dev_dri
+    @bind.bind_sys_dev_char
+    @bind.bind_pci_devices
+    proc_mount
+    tmp_as_tmpfs
+    @bind.bind_home_directory
+    @args.append "--unshare-all"
+    share_net
+    hostname
+    @args.append @environment.environment_variables
+    @args.append "--die-with-parent"
+    @args.append "--new-session"
+
+    @args.compact
   end
 
   # Performs cleanup operations after execution.
   def cleanup
     @machine_id&.cleanup
+    @bind&.cleanup
+  end
+
+  # Used by {#construct_bwrap_args}.
+  private def create_objects
+    @bind = Bwrap::Args::Bind.new
+    @bind.args = @args
+    @bind.command = @command
+    @bind.config = @config
+
+    @environment = Bwrap::Args::Environment.new
+    @environment.config = @config
+    @bind.environment = @environment
+
+    @features = Bwrap::Args::Features.new
+    @features.args = @args
+    @features.config = @config
+
+    @machine_id = Bwrap::Args::MachineId.new
+    @machine_id.config = @config
   end
 
   # Arguments for generating .Xauthority file.
   private def xauthority_args
-    return [] unless @config.xorg_application
+    return unless @config.xorg_application
 
     xauth_args = %W{ --ro-bind #{Dir.home}/.Xauthority #{Dir.home}/.Xauthority }
     debug "Binding following .Xauthority file: #{Dir.home}/.Xauthority"
-    xauth_args
+    @args.append xauth_args
   end
 
   # Arguments to read-only bind /etc/resolv.conf.
@@ -68,25 +98,29 @@ class Bwrap::Args::Construct
     source_resolv_conf = source_resolv_conf.realpath
 
     debug "Binding #{source_resolv_conf} as /etc/resolv.conf"
-    %W{ --ro-bind #{source_resolv_conf} /etc/resolv.conf }
+    @args.append %W{ --ro-bind #{source_resolv_conf} /etc/resolv.conf }
   end
 
   # Arguments to create `/run/user/#{uid}`.
   private def create_user_dir
     trace "Creating directory /run/user/#{uid}"
-    %W{ --dir /run/user/#{uid} }
+    @args.append %W{ --dir /run/user/#{uid} }
   end
 
   # Arguments to bind necessary pulseaudio data for audio support.
   private def read_only_pulseaudio
+    return unless @config.audio.include? :pulseaudio
+
     debug "Binding pulseaudio"
-    %W{ --ro-bind /run/user/#{uid}/pulse /run/user/#{uid}/pulse }
+    @args.append %W{ --ro-bind /run/user/#{uid}/pulse /run/user/#{uid}/pulse }
   end
 
   # Arguments to allow network connection inside sandbox.
   private def share_net
+    return unless @config.share_net
+
     verb "Sharing network"
-    %w{ --share-net }
+    @args.append %w{ --share-net }
   end
 
   # Arguments to set hostname to whatever is configured.
@@ -94,7 +128,7 @@ class Bwrap::Args::Construct
     return unless @config.hostname
 
     debug "Setting hostname to #{@config.hostname}"
-    %W{ --hostname #{@config.hostname} }
+    @args.append %W{ --hostname #{@config.hostname} }
   end
 
   # Returns current user id.

data/lib/bwrap/args/environment.rb

@@ -10,15 +10,46 @@ class Bwrap::Args::Environment < Hash
   # Instance of {Config}.
   attr_writer :config
 
-  # Returns used environment variables.
+  # Returns used environment variables wrapped as bwrap arguments.
   def environment_variables
     if debug?
       debug "Passing following environment variables to bwrap:\n" \
             "#{self}"
     end
 
+    env_paths
+
     map do |key, value|
+      if key == "PATH" and value.respond_to? :join
+        value = value.join ":"
+      end
+
       [ "--setenv", key, value ]
     end
   end
+
+  # @return [Array] All environment paths added via {Config#add_env_path} and other parsing logic
+  def env_paths
+    if @config.env_paths.respond_to? :each
+      self["PATH"] ||= []
+
+      self["PATH"] |= @config.env_paths
+    end
+
+    self["PATH"]
+  end
+
+  # Adds given paths to PATH environment variable defined in the sandbox.
+  #
+  # @param elements [String, Array] Path(s) to be added added to PATH environment variable
+  def add_to_path elements
+    self["PATH"] ||= []
+
+    if elements.respond_to? :each
+      self["PATH"] += elements
+    else
+      # Expecting elements to be single path element as a string.
+      self["PATH"] << elements
+    end
+  end
 end