safe_ruby 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 425c072f463f6327df204384704f8ae03a7492dd
-  data.tar.gz: 8fdd2f48678c45f09a9525e689dce7c7f2466ba4
+  metadata.gz: ad9f4276a328e546e667a18999ec069185672e87
+  data.tar.gz: 79a532fd77ae5db3be47561e1f7adcac4eea0f2f
 SHA512:
-  metadata.gz: a55b54043be58f25ecbe306885f732895a4c98816a6e4df9f379f26d7cb14249d2b7b79dc3f3fc44624ba6b70ad75e5fbd00cf8a4a97fbc8923982fdc1535fc6
-  data.tar.gz: c0e3ccf2fe3fc326ea06f3d9a5ca1ff255236e92a9a1f29244ccbae25dcb9aba602133116df105bd65d46f467fb403a324deede1df3419a85a5e0d7d1a902f2c
+  metadata.gz: 562a945aff8bbc1c005ea94fd4e070d275c8b8d6bab9e5f791a717444438f9d65b2d7a6d2272f492d07dfa95ba9a9865b75d1b8026a5bb5169d14c9c6c29eac3
+  data.tar.gz: 74c0f095b83446f66ecfe114592efd5589699583eb7f0a37208121f3b9c1d986693303a3193fcfe5b27d29cc27bc32cf302e1ff12603de5181e1a4155d575467

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.DS_STORE
+lib/.DS_STORE

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    safe_ruby (1.0.1)
+      childprocess (>= 0.3.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (0.7.1)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.18)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.1.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake
+  rspec
+  safe_ruby!
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 heruku
+
+MIT License
+
+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,41 @@
+Safe Ruby
+=========
+
+Safe Ruby provides a way to run untrusted ruby code outside of the current process in a safe environment.
+Creating this environment is largery based on jruby sandbox, whitelisting the methods one can use on potentially
+dangerous classes. Constants are also whitelisted, eliminating some core ruby functionality such as spawning
+another process.
+
+Getting Started
+==============
+
+Run `gem install safe_ruby` in your terminal, then `require 'safe_ruby'` in your app and you're ready to go.
+
+Examples
+========
+
+Evaluating ruby code
+
+```ruby
+  SafeRuby.eval('[1,2,3].map{ |n| n + 1 }')    #=> [2, 3, 4]
+  
+  SafeRuby.eval('system("rm *")')              #=> system is unavailable
+  
+  SafeRuby.eval('Kernel.abort')                #=> undefined method `abort' for Kernel:Module
+```
+
+Default timeout for evaluating is 5 seconds, but this can be specified.
+
+```ruby
+  SafeRuby.eval('loop{}')                      #<ChildProcess::TimeoutError: process still alive after 5 seconds>
+  
+  SafeRuby.eval('loop{}', timeout: 1)          #<ChildProcess::TimeoutError: process still alive after 1 seconds>
+```
+
+This library was built for a codeacademy-style tutoring app, so checking answers is built into the SafeRuby class
+
+```ruby
+  SafeRuby.check('[1,2,3].map{ |n| n + 1 }', '[2,3,4]')  #=> true
+```
+
+In this example, the second argument(expected answer) can also be untrusted, it will be run safely. 

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/lib/constant_whitelist.rb

@@ -1,7 +1,7 @@
-ALLOWED_CONSTANTS= 
-[ :Object, :Module, :Class, :BasicObject, :Kernel, :NilClass, :NIL, :Data, :TrueClass, :TRUE, :FalseClass, :FALSE, :Encoding, 
-	:Comparable, :Enumerable, :String, :Symbol, :Exception, :SystemExit, :SignalException, :Interrupt, :StandardError, :TypeError,
- 	:ArgumentError, :IndexError, :KeyError, :RangeError, :ScriptError, :SyntaxError, :LoadError, :NotImplementedError, :NameError,
+ALLOWED_CONSTANTS= [
+  :Object, :Module, :Class, :BasicObject, :Kernel, :NilClass, :NIL, :Data, :TrueClass, :TRUE, :FalseClass, :FALSE, :Encoding, 
+  :Comparable, :Enumerable, :String, :Symbol, :Exception, :SystemExit, :SignalException, :Interrupt, :StandardError, :TypeError,
+  :ArgumentError, :IndexError, :KeyError, :RangeError, :ScriptError, :SyntaxError, :LoadError, :NotImplementedError, :NameError,
   :NoMethodError, :RuntimeError, :SecurityError, :NoMemoryError, :EncodingError, :SystemCallError, :Errno, :ZeroDivisionError,
   :FloatDomainError, :Numeric, :Integer, :Fixnum, :Float, :Bignum, :Array, :Hash,  :Struct, :RegexpError, :Regexp,
   :MatchData, :Marshal, :Range, :IOError, :EOFError, :IO, :STDIN, :STDOUT, :STDERR, :Time, :Random,
@@ -9,4 +9,5 @@ ALLOWED_CONSTANTS=
   :StopIteration, :RubyVM, :Thread, :TOPLEVEL_BINDING, :ThreadGroup, :Mutex, :ThreadError, :Fiber, :FiberError, :Rational, :Complex,
   :RUBY_VERSION, :RUBY_RELEASE_DATE, :RUBY_PLATFORM, :RUBY_PATCHLEVEL, :RUBY_REVISION, :RUBY_DESCRIPTION, :RUBY_COPYRIGHT, :RUBY_ENGINE,
   :TracePoint, :ARGV, :Gem, :RbConfig, :Config, :CROSS_COMPILING, :Date, :ConditionVariable, :Queue, :SizedQueue, :MonitorMixin, :Monitor,
-  :Exception2MessageMapper, :IRB, :RubyToken, :RubyLex, :Readline, :RUBYGEMS_ACTIVATION_MONITOR]
+  :Exception2MessageMapper, :IRB, :RubyToken, :RubyLex, :Readline, :RUBYGEMS_ACTIVATION_MONITOR
+]

data/lib/make_safe_code.rb

@@ -16,7 +16,7 @@ def keep_methods(klass, methods)
   undef_methods = (klass.methods(false) - methods)
   undef_methods.each do |method|
     klass.send(:undef_method, method)
-  end  
+  end
 end
 
 def clean_constants
@@ -48,4 +48,4 @@ end
 
 clean_constants
 
-STRING
+STRING

data/lib/method_whitelist.rb

@@ -1,41 +1,41 @@
 IO_S_METHODS = %w[
-	new
-	foreach
-	open
+  new
+  foreach
+  open
 ]
 
 KERNEL_S_METHODS = %w[
-	Array
-	binding
-	block_given?
-	catch
-	chomp
-	chomp!
-	chop
-	chop!
-	eval
-	fail
-	Float
-	format
-	global_variables
-	gsub
-	gsub!
-	Integer
-	iterator?
-	lambda
-	local_variables
-	loop
-	method_missing
-	proc
-	raise
-	scan
-	split
-	sprintf
-	String
-	sub
-	sub!
-	throw
-	].freeze
+  Array
+  binding
+  block_given?
+  catch
+  chomp
+  chomp!
+  chop
+  chop!
+  eval
+  fail
+  Float
+  format
+  global_variables
+  gsub
+  gsub!
+  Integer
+  iterator?
+  lambda
+  local_variables
+  loop
+  method_missing
+  proc
+  raise
+  scan
+  split
+  sprintf
+  String
+  sub
+  sub!
+  throw
+  ].freeze
 
 SYMBOL_S_METHODS = %w[
 all_symbols
@@ -268,4 +268,4 @@ upcase!
 upto
 []
 []=
-].freeze
+].freeze

data/lib/safe_ruby.rb

@@ -2,8 +2,8 @@ require 'childprocess'
 require_relative 'method_whitelist'
 require_relative 'constant_whitelist'
 require_relative 'make_safe_code'
-require_relative 'safe_ruby_runner'
+require_relative 'safe_ruby/runner'
+require_relative 'safe_ruby/version'
 
 class SafeRuby
-	VERSION = "1.0.1"
-end
+end

data/lib/{safe_ruby_runner.rb → safe_ruby/runner.rb}

@@ -1,3 +1,5 @@
+require 'tempfile'
+
 class EvalError < StandardError
   def initialize(msg); super; end
 end
@@ -29,7 +31,7 @@ class SafeRuby
         process.poll_for_exit(@timeout)
       rescue ChildProcess::TimeoutError => e
         process.stop # tries increasingly harsher methods to kill the process.
-        return e
+        return e.message
       end
       write.close
       temp.unlink
@@ -55,7 +57,6 @@ class SafeRuby
   private
 
   def build_tempfile
-    require 'tempfile'
     file = Tempfile.new('saferuby')
     file.write(MAKE_SAFE_CODE)
     file.write <<-STRING

data/lib/safe_ruby/version.rb

@@ -0,0 +1,7 @@
+class SafeRuby
+  MAJOR_VERSION = 1
+  MINOR_VERSION = 0
+  RELEASE_VERSION = 2
+
+  VERSION = [MAJOR_VERSION, MINOR_VERSION, RELEASE_VERSION].join('.')
+end

data/safe_ruby.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safe_ruby/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'safe_ruby'
+  s.version     = SafeRuby::VERSION
+  s.date        = '2013-12-04'
+  s.authors     = ["Uku Taht"]
+  s.email       = 'uku.taht@gmail.com'
+
+  s.summary     = "Run untrusted ruby code in a safe environment"
+  s.description = "Evaluates ruby code by writing it to a tempfile and spawning a child process. Uses a whitelist of methods and constants to keep, for example one cannot run system commands in the environment created by this gem. The environment created by the untrusted code does not leak out into the parent process."
+  s.homepage    = 'http://rubygems.org/gems/safe_ruby'
+  s.license     = 'MIT'
+
+  s.executables    = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files          = `git ls-files`.split("\n")
+  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'childprocess', '>= 0.3.9'
+
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+end

data/spec/safe_ruby_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe SafeRuby do
+  describe '#eval' do
+    it 'allows basic operations' do
+      expect(SafeRuby.eval('4 + 5')).to eq 9
+      expect(SafeRuby.eval('[4, 5].map{|n| n+1}')).to eq [5 ,6]
+    end
+
+    it 'returns correct object' do
+      expect(SafeRuby.eval('[1,2,3]')).to eq [1,2,3]
+    end
+
+    MALICIOUS_OPERATIONS = [
+      "system('rm *')",
+      "`rm *`",
+      "Kernel.abort",
+      "cat spec/spec_helper.rb",
+      "File.class_eval { `echo Hello` }",
+      "FileUtils.class_eval { `echo Hello` }",
+      "Dir.class_eval { `echo Hello` }",
+      "FileTest.class_eval { `echo Hello` }",
+      "File.eval \"`echo Hello`\"",
+      "FileUtils.eval \"`echo Hello`\"",
+      "Dir.eval \"`echo Hello`\"",
+      "FileTest.eval \"`echo Hello`\"",
+      "File.instance_eval { `echo Hello` }",
+      "FileUtils.instance_eval { `echo Hello` }",
+      "Dir.instance_eval { `echo Hello` }",
+      "FileTest.instance_eval { `echo Hello` }",
+      "f=IO.popen('uname'); f.readlines; f.close",
+      "IO.binread('/etc/passwd')",
+      "IO.read('/etc/passwd')",
+    ]
+
+    MALICIOUS_OPERATIONS.each do |op|
+      it "protects from malicious operations like (#{op})" do
+        expect{
+          SafeRuby.eval(op) 
+        }.to raise_error RuntimeError
+      end
+    end
+
+    describe "options" do
+      describe "timeout" do
+        it 'defaults to a 5 second timeout' do
+          time = Benchmark.realtime do
+            SafeRuby.eval('(1..100000).map {|n| n**100}')
+          end
+          expect(time).to be_within(0.5).of(5)
+        end
+
+        it 'allows custom timeout' do
+          time = Benchmark.realtime do
+            SafeRuby.eval('(1..100000).map {|n| n**100}', timeout: 1)
+          end
+          expect(time).to be_within(0.5).of(1)
+        end
+      end
+
+      describe "raising errors" do
+        it "defaults to raising errors" do
+          expect{ SafeRuby.eval("asdasdasd") }.to raise_error RuntimeError
+        end
+
+        it "allows not raising errors" do
+          expect {SafeRuby.eval("asdasd", raise_errors: false)}.to_not raise_error
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'safe_ruby'
+require 'benchmark'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Uku Taht
@@ -14,30 +14,58 @@ dependencies:
   name: childprocess
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.9
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
 description: Evaluates ruby code by writing it to a tempfile and spawning a child
   process. Uses a whitelist of methods and constants to keep, for example one cannot
   run system commands in the environment created by this gem. The environment created
@@ -47,11 +75,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/safe_ruby.rb
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
 - lib/constant_whitelist.rb
 - lib/make_safe_code.rb
 - lib/method_whitelist.rb
-- lib/safe_ruby_runner.rb
+- lib/safe_ruby.rb
+- lib/safe_ruby/runner.rb
+- lib/safe_ruby/version.rb
+- safe_ruby.gemspec
+- spec/safe_ruby_spec.rb
+- spec/spec_helper.rb
 homepage: http://rubygems.org/gems/safe_ruby
 licenses:
 - MIT
@@ -62,18 +101,20 @@ 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.1.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Run untrusted ruby code in a safe environment
-test_files: []
+test_files:
+- spec/safe_ruby_spec.rb
+- spec/spec_helper.rb