cvisor 0.1.0-x86_64-linux-musl

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e983fc78cc4f7cdb9d04456f9f2060fd9cbd6f2c1be9116cdd056ba0ce25bf6
+  data.tar.gz: 0f96222560cfcea664a21c59ce7222a27576fddfe118dd9659c09e9f256398a8
+SHA512:
+  metadata.gz: ba864664965840e7212c1661617a254a5dc7b4b0d8c7177fa4fc1a186d675c94c5103a94024eb50d4d524678a26daadb87cae834f187c2c87a7d158697e2cba4
+  data.tar.gz: b136f6e692c27db9e8e6861f954eecfcd3f80672fde8ad208ba4a57d3d501aadf8016e7f23ba9fbef2751a557cd69b2ddc118288c5b76bfb6fa49d349e7009ea

data/README.md

@@ -0,0 +1,43 @@
+# cVisor — Ruby SDK
+
+A `fiddle` FFI wrapper over the `libcvisor` C ABI. Linux-only.
+
+## Usage
+
+```ruby
+require "cvisor"
+
+sb = Cvisor::Sandbox.new
+out = sb.run("echo hello")
+puts out.stdout   # "hello\n"
+puts out.stderr   # ""
+```
+
+`Sandbox#run(cmd)` blocks until the sandboxed command exits and returns an
+`Output` with `#stdout` / `#stderr` (String) and `#stdout_bytes` /
+`#stderr_bytes`.
+
+## Interactive console
+
+Launch an IRB session with a live sandbox preloaded:
+
+```bash
+bin/console
+```
+
+```
+cVisor interactive console
+  sb          -> a Sandbox instance
+  sh("cmd")   -> run a shell command in the sandbox, printing stdout/stderr
+  Cvisor::Sandbox.new -> create your own
+
+irb(main):001> sh("echo hello; uname -n")
+hello
+cvisor
+```
+
+## Development
+
+The SDK loads `libcvisor.so`. Build it from the repo root (`cargo xtask ffi`),
+which drops a copy into `native/`, or point the SDK at one via the `CVISOR_LIB`
+environment variable.

data/bin/console

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Interactive cVisor console.
+#
+# Drops you into an IRB session with a live sandbox ready to use:
+#
+#   sb          -> a Cvisor::Sandbox instance
+#   sh("ls /")  -> run a shell command in the sandbox, printing stdout/stderr
+#   Cvisor::Sandbox.new -> create your own
+#
+# Run with `bin/console` (or `bundle exec console`).
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "cvisor"
+require "irb"
+
+sb = Cvisor::Sandbox.new
+
+# Top-level `sh` helper that runs a command in `sb` and prints its output.
+define_singleton_method(:sh) do |command|
+  out = sb.run(command)
+  $stdout.print(out.stdout)
+  $stderr.print(out.stderr)
+  out
+end
+
+puts <<~BANNER
+  cVisor interactive console
+    sb          -> a Sandbox instance
+    sh("cmd")   -> run a shell command in the sandbox, printing stdout/stderr
+    Cvisor::Sandbox.new -> create your own
+BANNER
+
+binding.irb

data/lib/cvisor.rb

@@ -0,0 +1,92 @@
+# cVisor Ruby SDK — Fiddle FFI wrapper over the libcvisor C ABI. Linux-only.
+#
+#   require "cvisor"
+#   out = Cvisor::Sandbox.new.run("echo hello")
+#   puts out.stdout   # "hello\n"
+
+require "fiddle"
+require "fiddle/import"
+
+module Cvisor
+  # Low-level binding to libcvisor via Fiddle.
+  module Native
+    extend Fiddle::Importer
+
+    def self.library_path
+      return ENV["CVISOR_LIB"] if ENV["CVISOR_LIB"]
+      arch = RbConfig::CONFIG["host_cpu"] =~ /(aarch64|arm64)/ ? "aarch64" : "x86_64"
+      here = File.expand_path("../native", __dir__)
+      [
+        File.join(here, "libcvisor-#{arch}.so"),
+        File.join(here, "libcvisor.so"),
+      ].find { |p| File.exist?(p) } || File.join(here, "libcvisor-#{arch}.so")
+    end
+
+    dlload library_path
+
+    extern "void* cvisor_sandbox_new(void)"
+    extern "void cvisor_sandbox_free(void*)"
+    extern "void cvisor_sandbox_set_log_level(void*, int)"
+    extern "void* cvisor_run(void*, const char*)"
+    extern "void cvisor_output_free(void*)"
+    extern "void* cvisor_output_stdout(void*, void*)"
+    extern "void* cvisor_output_stderr(void*, void*)"
+    extern "void cvisor_bytes_free(void*, size_t)"
+  end
+
+  # Captured output of one run.
+  class Output
+    attr_reader :stdout_bytes, :stderr_bytes
+
+    def initialize(stdout_bytes, stderr_bytes)
+      @stdout_bytes = stdout_bytes
+      @stderr_bytes = stderr_bytes
+    end
+
+    def stdout = @stdout_bytes.force_encoding("UTF-8")
+    def stderr = @stderr_bytes.force_encoding("UTF-8")
+  end
+
+  class Sandbox
+    def initialize
+      @ptr = Native.cvisor_sandbox_new
+      raise "failed to create sandbox" if @ptr.null?
+    end
+
+    def set_log_level(level)
+      Native.cvisor_sandbox_set_log_level(@ptr, level == "DEBUG" ? 1 : 0)
+    end
+
+    def run(command)
+      out = Native.cvisor_run(@ptr, command)
+      raise "sandbox run failed" if out.null?
+      begin
+        Output.new(read_output(out, :cvisor_output_stdout),
+                   read_output(out, :cvisor_output_stderr))
+      ensure
+        Native.cvisor_output_free(out)
+      end
+    end
+
+    def close
+      return unless @ptr && !@ptr.null?
+      Native.cvisor_sandbox_free(@ptr)
+      @ptr = nil
+    end
+
+    private
+
+    def read_output(out, accessor)
+      len = Fiddle::Pointer.malloc(Fiddle::SIZEOF_SIZE_T, Fiddle::RUBY_FREE)
+      ptr = Native.public_send(accessor, out, len)
+      n = len[0, Fiddle::SIZEOF_SIZE_T].unpack1(Fiddle::SIZEOF_SIZE_T == 8 ? "Q" : "L")
+      return "".b if ptr.null? || n.zero?
+
+      begin
+        ptr[0, n].b
+      ensure
+        Native.cvisor_bytes_free(ptr, n)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: cvisor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: x86_64-linux-musl
+authors:
+- butter.dev
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A thin Fiddle FFI wrapper over the libcvisor C ABI. Linux-only.
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- lib/cvisor.rb
+- native/libcvisor-x86_64.so
+homepage: https://github.com/tsirysndr/cVisor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tsirysndr/cVisor
+  source_code_uri: https://github.com/tsirysndr/cVisor
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: In-process Linux sandbox — Ruby SDK (Fiddle FFI over libcvisor)
+test_files: []