shells 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13762830a779f79e8479b3d5c41fe66962ed63b9
+  data.tar.gz: 24241daef4637de27a2905a03daee0aba6e85bfe
+SHA512:
+  metadata.gz: b2e6a7496728f5cd40741c5eeb8a83675a48a2a364b703e420e67d929ff9b1039d6eb2080e3d993141fd9be6ef8796fa2c66e7fce965e19965eb592a0fba219e
+  data.tar.gz: c6377f55371051f7df873a78a0befe1e7c7a79c6a32ad3e3eac2493a95b423a7b48b84e2fc3694a14bbd31833e54f2bd983bcbfdc309fc74d459995e5050eced

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test/config.yml
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Beau Barker
+
+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,78 @@
+# Shells
+
+This gem is a collection of shell classes that can be used to interact with various devices.
+It started as a secure shell to interact with SSH hosts, then it received a shell to access pfSense devices.
+A natural progression had me adding a serial shell and another shell to access pfSense devices over serial.
+
+If you can't tell, it was primarily developed to interact with pfSense devices, but also tends to work well
+for interacting with other devices and hosts as well.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shells'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shells
+
+
+## Usage
+
+Any of the various "Session" classes can be used to interact with a device or host.
+
+```ruby
+Shells::SshSession.new(host: 'my.device.name.or.ip', user: 'somebody', password: 'secret') do |sh|
+  sh.exec "cd /usr/local/bin"
+  user_bin_files = sh.exec("ls -A1").split("\n")
+  @app_is_installed = user_bin_files.include?("my_app")
+end
+```
+
+Every session constructor works the same way.  The shell is connected to, the prompt is set, and then the block
+of code passed to the constructor is executed on the shell.  After the code block completes, the session is finalized
+and the shell is closed.
+
+The `Shells` module is designed to allow you to forego the `.new` as well.  So `Shells::SshSession(...)` is the same as 
+`Shells::SshSession.new(...)`.
+
+In most cases you will be sending commands to the shell using the `.exec` method of the shell passed to the code block.
+The `.exec` method returns the output of the command and then you can process the results.  You can also request that 
+the `.exec` method retrieves the exit code from the command as well, but this will only work in some shells.
+
+```ruby
+Shells::SshSession(host: 'my.device.name.or.ip', user: 'somebody', password: 'secret') do |sh|
+  # By default shells do not retrieve exit codes or raise on non-zero exit codes.
+  # These parameters can be set in the options list for the constructor as well to change the 
+  # default behavior.
+  
+  # This command will execute the command and then retrieve the exit code.
+  # We then perform an action based on the exit code.
+  sh.exec "some command", retrieve_exit_code: true
+  raise 'Some Error' if sh.last_exit_code != 0
+  
+  # This command will execute the command then automatically raise an error if the exit code
+  # is non-zero.  The error raised is a Shells::NonZeroExitCode exception which happens to have
+  # an exit_code property for your rescue code to examine.
+  sh.exec "some command", retrieve_exit_code: true, on_non_zero_exit_code: :raise
+end
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/barkerest/shells.
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shells"
+
+# 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(__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/lib/shells/bash_common.rb

@@ -0,0 +1,170 @@
+require 'base64'
+
+module Shells
+  ##
+  # Provides some common functionality for bash-like shells.
+  module BashCommon
+
+    ##
+    # Reads from a file on the device.
+    def read_file(path, use_method = nil)
+      if use_method
+        use_method = use_method.to_sym
+        raise ArgumentError, "use_method (#{use_method.inspect}) is not a valid method." unless file_methods.include?(use_method)
+        raise Shells::ShellError, "The #{use_method} binary is not available with this shell." unless which(use_method)
+        send "read_file_#{use_method}", path
+      elsif default_file_method
+        return send "read_file_#{default_file_method}", path
+      else
+        raise Shells::ShellError, 'No supported binary to encode/decode files.'
+      end
+    end
+
+    ##
+    # Writes to a file on the device.
+    def write_file(path, data, use_method = nil)
+      if use_method
+        use_method = use_method.to_sym
+        raise ArgumentError, "use_method (#{use_method.inspect}) is not a valid method." unless file_methods.include?(use_method)
+        raise Shells::ShellError, "The #{use_method} binary is not available with this shell." unless which(use_method)
+        send "write_file_#{use_method}", path, data
+      elsif default_file_method
+        return send "write_file_#{default_file_method}", path, data
+      else
+        raise Shells::ShellError, 'No supported binary to encode/decode files.'
+      end
+    end
+
+    protected
+
+    ##
+    # Gets an exit code by echoing the $? variable from the environment.
+    #
+    # This can be overridden by specifying either a string command or a Proc
+    # for the :override_get_exit_code option in the shell's options.
+    def get_exit_code #:nodoc:
+      cmd = options[:override_get_exit_code] || 'echo $?'
+      if cmd.respond_to?(:call)
+        cmd.call(self)
+      else
+        debug 'Retrieving exit code from last command...'
+        push_buffer
+        send_data cmd + line_ending
+        wait_for_prompt nil, 1
+        ret = command_output(cmd).strip.to_i
+        pop_discard_buffer
+        debug 'Exit code: ' + ret.to_s
+        ret
+      end
+    end
+
+    ##
+    # Gets the path to a program, or nil if not found.
+    def which(program)
+      ret = exec("which #{program} 2>/dev/null").strip
+      ret == '' ? nil : ret
+    end
+
+    private
+
+    def file_methods
+      @file_methods ||= [
+          :base64,
+          :openssl
+      ]
+    end
+
+    def default_file_method
+      # Find the first method that should work.
+      unless instance_variable_defined?(:@default_file_method)
+        @default_file_method = file_methods.find { |meth| which(meth) }
+      end
+      @default_file_method
+    end
+
+    def with_b64_file(path, data, &block)
+      data = Base64.encode64(data)
+
+      max_cmd_length = 2048
+
+      # Send 1 line at a time (this will be SLOW for large files).
+      lines = data.gsub("\r\n", "\n").split("\n")
+
+      # Construct a temporary filename.
+      b64path = path + '.b64'
+      if exec_for_code("[ -f #{b64path.inspect} ]") == 0
+        # File exists.
+        cnt = 2
+        while exec_for_code("[ -f #{(b64path + cnt.to_s).inspect} ]") == 0
+          cnt += 1
+        end
+        b64path += cnt.to_s
+      end
+
+      debug "Writing #{lines.count} lines to #{b64path}..."
+
+      # Create/overwrite file with the first line.
+      first_line = lines.delete_at 0
+      exec "echo #{first_line} > #{b64path.inspect}"
+
+      # Create a queue.
+      cmds = []
+      lines.each do |line|
+        cmds << "echo #{line} >> #{b64path.inspect}"
+      end
+
+      # Process the queue sending as many at a time as possible.
+      while cmds.any?
+        cmd = cmds.delete(cmds.first)
+        while cmds.any? && cmd.length + cmds.first.length + 4 <= max_cmd_length
+          cmd += ' && ' + cmds.delete(cmds.first)
+        end
+        exec cmd
+      end
+
+      ret = block.call(b64path)
+
+      exec "rm #{b64path.inspect}"
+
+      ret
+    end
+
+    def write_file_base64(path, data)
+      with_b64_file path, data do |b64path|
+        exec_for_code "base64 -d #{b64path.inspect} > #{path.inspect}", command_timeout: 30
+      end
+    end
+
+    def write_file_openssl(path, data)
+      with_b64_file path, data do |b64path|
+        exec_for_code "openssl base64 -d < #{b64path.inspect} > #{path.inspect}"
+      end
+    end
+
+    def write_file_perl(path, data)
+      with_b64_file path, data do |b64path|
+        exec_for_code "perl -MMIME::Base64 -ne 'print decode_base64($_)' < #{b64path.inspect} > #{path.inspect}"
+      end
+    end
+
+    def read_file_base64(path)
+      data = exec "base64 -w 0 #{path.inspect}", retrieve_exit_code: true, on_non_zero_exit_code: :ignore, command_timeout: 30
+      return nil if last_exit_code != 0
+      Base64.decode64 data
+    end
+
+    def read_file_openssl(path)
+      data = exec "openssl base64 < #{path.inspect}", retrieve_exit_code: true, on_non_zero_exit_code: :ignore, command_timeout: 30
+      return nil if last_exit_code != 0
+      Base64.decode64 data
+    end
+
+    def read_file_perl(path)
+      data = exec "perl -MMIME::Base64 -ne 'print encode_base64($_)' < #{path.inspect}", retrieve_exit_code: true, on_non_zero_exit_code: :ignore, command_timeout: 30
+      return nil if last_exit_code != 0
+      Base64.decode64 data
+    end
+
+
+  end
+end

data/lib/shells/errors.rb

@@ -0,0 +1,57 @@
+module Shells
+  ##
+  # An error occurring within the SecureShell class aside from argument errors.
+  class ShellError < StandardError
+
+  end
+
+  ##
+  # An error raised when a provided option is invalid.
+  class InvalidOption < ShellError
+
+  end
+
+  ##
+  # An error raised when a command requiring a session is attempted after the session has been completed.
+  class SessionCompleted < ShellError
+
+  end
+
+  ##
+  # An error raised when a command exits with a non-zero status.
+  class NonZeroExitCode < ShellError
+    ##
+    # The exit code triggering the error.
+    attr_accessor :exit_code
+
+    ##
+    # Creates a new non-zero exit code error.
+    def initialize(exit_code)
+      self.exit_code = exit_code
+    end
+
+    def message # :nodoc:
+      "The exit code was #{exit_code}."
+    end
+  end
+
+  ##
+  # An error raised when a session is waiting for output for too long.
+  class SilenceTimeout < ShellError
+
+  end
+
+  ##
+  # An error raise when a session is waiting for a command to finish for too long.
+  class CommandTimeout < ShellError
+
+  end
+
+  ##
+  # An error raised when the session fails to set the prompt in the shell.
+  class FailedToSetPrompt < ShellError
+
+  end
+
+
+end