safe_exec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65a65d3df26d5dfbe8d29930824856b3ce020febf79614fd7c29ec9710a80493
+  data.tar.gz: e07f7e50651e91d65d0b132355fa43a7fee0bb32f189137f30641be300d64819
+SHA512:
+  metadata.gz: 16d04e2ce8be13de2cd530fb2aaa74a29d34a3207fd9533f117df0976b861f4e5918a92d0a1b4dd1fbfabed8644a0a0c82c8ecbbd8985edc8f6ee662f79fe3d5
+  data.tar.gz: 932713fb15acd1abedd5528177f69ebbc2d2f56eb0b8fcff168904ce639d8b0c2d5625b9f5725438006a64d1e83acb2a2697048e6c605bf419c744ef3d4ad308

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+shexec

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sheldon Hearn
+
+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,39 @@
+# SafeExec
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/safe_exec`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safe_exec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safe_exec
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/safe_exec/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safe_exec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/safe_exec/executor.rb

@@ -0,0 +1,13 @@
+require 'safe_exec/pipe_executor'
+
+module SafeExec
+
+  class Executor < PipeExecutor
+
+    def initialize
+      super(StringIO.new.tap { |io| io.close }, $stdout, $stderr)
+    end
+
+  end
+
+end

data/lib/safe_exec/no_output_executor.rb

@@ -0,0 +1,23 @@
+require 'safe_exec/executor'
+
+module SafeExec
+
+  class NoOutputExecutor < Executor
+
+    module NullIO
+      def self.write(string)
+      end
+
+      def self.flush
+      end
+    end
+
+    def initialize
+      super
+      @stdout = NullIO
+      @stderr = NullIO
+    end
+
+  end
+
+end

data/lib/safe_exec/pipe_executor.rb

@@ -0,0 +1,99 @@
+require 'open3'
+require 'timeout'
+require 'thread'
+
+module SafeExec
+
+  class PipeExecutor
+
+    PAGE_SIZE = 4096
+
+    def initialize(stdin, stdout, stderr)
+      @stdin, @stdout, @stderr = stdin, stdout, stderr
+      @mutex = Mutex.new
+    end
+
+    def run(cmd, *args)
+      assert_untainted_command(cmd, *args)
+      @mutex.synchronize do
+        Open3.popen3([cmd, cmd], *args) do |stdin, stdout, stderr, wait_thr|
+          @threads = [
+            pusher(@stdin, stdin),
+            drainer(stdout, @stdout),
+            drainer(stderr, @stderr)
+          ]
+          @threads.each { |t| t.abort_on_exception = true }
+
+          yield wait_thr if block_given?
+
+          wait_thr.value.tap { @threads.each { |t| t.join } }
+        end
+      end
+    end
+
+    def timeout(seconds, exception = Timeout::Error)
+      TimeoutDelegate.new(self, seconds, exception)
+    end
+
+    private
+
+      def pusher(input, output)
+        Thread.new do
+          stream(input, output)
+          output.close unless output.closed?
+        end
+      end
+
+      def drainer(input, output)
+        Thread.new do
+          stream(input, output)
+          output.flush
+        end
+      end
+
+      def stream(input, output)
+        until input.closed? or input.eof?
+          output.write input.read(PAGE_SIZE)
+        end
+      end
+
+      def assert_untainted_command(*components)
+        components.each do |component|
+          raise SecurityError.new("refusing to construct a command line from tainted component #{component}") if component.tainted?
+        end
+      end
+
+      def abort
+        @threads.each { |t| t.kill }
+      end
+
+      class TimeoutDelegate
+
+        def initialize(executor, timeout, exception)
+          @executor, @timeout, @exception = executor, timeout, exception
+        end
+
+        def run(cmd, *args)
+          @executor.run(cmd, *args) do |t|
+            begin
+              Timeout.timeout(@timeout, @exception) do
+                yield t if block_given?
+                t.value
+              end
+            rescue @exception => e
+              begin
+                @executor.send(:abort)
+                Process.kill("TERM", t.pid)
+              rescue Errno::ESRCH
+              ensure
+                raise e
+              end
+            end
+          end
+        end
+
+      end
+
+  end
+
+end

data/lib/safe_exec/streaming_executor.rb

@@ -0,0 +1,15 @@
+require 'safe_exec/executor'
+
+module SafeExec
+
+  class StreamingExecutor < Executor
+
+    def initialize(stdout, stderr)
+      super()
+      @stdout = stdout
+      @stderr = stderr
+    end
+
+  end
+
+end

data/lib/safe_exec/version.rb

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

data/lib/safe_exec.rb

@@ -0,0 +1,6 @@
+Dir.glob(File.join(File.dirname(__FILE__), "safe_exec", "**", "*.rb")) do |f|
+  require f
+end
+
+module SafeExec
+end

data/safe_exec.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safe_exec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe_exec"
+  spec.version       = SafeExec::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = "Safe shell executor"
+  spec.homepage      = "https://github.com/sheldonh/safe_exec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: safe_exec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- sheldonh@starjuice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safe_exec.rb
+- lib/safe_exec/executor.rb
+- lib/safe_exec/no_output_executor.rb
+- lib/safe_exec/pipe_executor.rb
+- lib/safe_exec/streaming_executor.rb
+- lib/safe_exec/version.rb
+- safe_exec.gemspec
+homepage: https://github.com/sheldonh/safe_exec
+licenses:
+- MIT
+metadata: {}
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Safe shell executor
+test_files: []