capsicum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e5799b3a6ff47316dbc821b3adfc49926eb4929
+  data.tar.gz: e85c0fbdae996894169ff9ca79f95e9bc21f3b81
+SHA512:
+  metadata.gz: f838a9d42d998fefdb2f334e79912b41612a9ae41c46efa3a52d559cc13c1d7d6c9f64dcc3e2c84d076c8a304d81c39efd8cd8c01ca943208cb411e50539e23c
+  data.tar.gz: 5f530f73ea30050fc8bbad4539f32ba435346cc7fa2e17fab8e8efe08bb40621f038e961e5f2a1e08e03fe4a904299a1af7bd7f8ff8111d3b481eb8c5259b60b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capsicum.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Thomas Hurst
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# Capsicum
+
+A simple FFI wrapper around the [Capsicum](https://wiki.freebsd.org/Capsicum)
+OS capability and sandbox framework.
+
+
+## Installation
+
+A Capsicum-enabled OS is, of course, required.  FreeBSD 10+ (or derivative),
+possibly [capsicum-linux](http://capsicum-linux.org/).
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capsicum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capsicum
+
+
+## Usage
+
+Basic synopsis:
+
+```ruby
+Capsicum.sandboxed?    # => false
+Capsicum.enter!        # => true
+Capsicum.sandboxed?    # => true
+
+File.new("/dev/null")  # => Errno::ECAPMODE: Not permitted in capability mode @ rb_sysopen - /dev/null
+TCPSocket.new("0", 80) # => Errno::ECAPMODE: Not permitted in capability mode - connect(2) for "0" port 80
+`rm -rf /`             # => Errno::ECAPMODE: Not permitted in capability mode - rm
+system "rm -rf /"      # => nil
+require 'time'         # => LoadError: cannot load such file -- time
+```
+
+i.e. anything that involves opening a file, connecting a socket, or executing a
+program is verboten.  Kinda.
+
+On fork-capable Rubies, you can also do this:
+
+```ruby
+Capsicum.sandboxed?   # => false
+
+status = Capsicum.within_sandbox do
+  Capsicum.sandboxed? # => true
+  exit 42
+end
+
+Capsicum.sandboxed?   # => false
+status.exitstatus     # => 42
+```
+
+The result is a Process::Status object.
+
+
+## But How Can I get Anything Done?
+
+Open your files and sockets before entering the sandbox.  If you have a
+`TCPServer` open, for example, you can still call `#accept` on it, so a useful
+server could conceivably run within it.
+
+You *can* open new files, but this requires access to *at() syscalls.  If Ruby
+supported them, it might look something like this:
+
+```ruby
+dir = Dir.open("/path/to/my/files")
+
+Capsicum.enter!
+
+file = File.openat(dir, "mylovelyfile")
+File.renameat(dir, "foo", dir, "bar")
+File.unlinkat(dir, "moo")
+```
+
+Unfortunately, it doesn't.  See https://bugs.ruby-lang.org/issues/10181
+
+You may consider spawning off workers, maintaining a privileged master process,
+and using IPC to communicate with them.
+
+## Todo
+
+Wrap Casper to provide DNS services, additional rights controls, etc.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Freaky/ruby-capsicum.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capsicum"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capsicum.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capsicum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capsicum"
+  spec.version       = Capsicum::VERSION
+  spec.authors       = ["Thomas Hurst"]
+  spec.email         = ["tom@hur.st"]
+
+  spec.summary       = %q{Experimental interface to Capsicum sandboxing}
+  spec.homepage      = "https://github.com/Freaky/ruby-capsicum"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "ffi", "~> 1.9"
+end

data/lib/capsicum.rb

@@ -0,0 +1,71 @@
+require "capsicum/version"
+require 'ffi'
+
+module Capsicum
+  class IntPtr < FFI::Struct
+    layout :value, :int
+  end
+
+  module LibC
+    extend FFI::Library
+    ffi_lib [FFI::CURRENT_PROCESS, 'c']
+
+    attach_variable :errno, :int
+
+    attach_function :cap_enter, [], :int
+    attach_function :cap_getmode, [IntPtr], :int
+  end
+
+  # Check if we're in capability mode.
+  #
+  # @see cap_getmode(2)
+  #
+  # @return [Boolean] true if we've entered capability mode
+  # @raise [Errno::ENOTCAPABLE] - Capsicum not enabled.
+  def sandboxed?
+    ptr = IntPtr.new
+    ret = LibC.cap_getmode(ptr)
+
+    if ret == 0
+      ptr[:value] == 1
+    else
+      raise SystemCallError.new("cap_getmode", LibC.errno)
+    end
+  end
+
+  # Enter capability sandbox mode.
+  #
+  # @see cap_enter(2)
+  #
+  # @return [Boolean] true if we've entered capability mode.
+  # @raise [Errno::ENOTCAPABLE] - Capsicum not enabled.
+  def enter!
+    ret = LibC.cap_enter
+
+    if ret == 0
+      return true
+    else
+      raise SystemCallError.new("cap_enter", LibC.errno)
+    end
+  end
+
+  # Run the block within a forked process in capability mode and wait for it to
+  # complete.
+  #
+  # @yield block to run within the forked child.
+  # @return [Process::Status] exit status of the forked child.
+  def within_sandbox
+    return enum_for(:within_sandbox) unless block_given?
+
+    pid = fork do
+      Capsicum.enter!
+      yield
+    end
+
+    Process.waitpid2(pid).last
+  end
+
+  module_function :sandboxed?
+  module_function :enter!
+  module_function :within_sandbox
+end

data/lib/capsicum/version.rb

@@ -0,0 +1,3 @@
+module Capsicum
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: capsicum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Hurst
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: 
+email:
+- tom@hur.st
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capsicum.gemspec
+- lib/capsicum.rb
+- lib/capsicum/version.rb
+homepage: https://github.com/Freaky/ruby-capsicum
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Experimental interface to Capsicum sandboxing
+test_files: []