remotus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a719c4faff9f018cf95614e68886b53475218bb27a73cde4579bbf7eb90d638b
+  data.tar.gz: f66e7025b43d7d343f269c076824eda4061b7565b418ee3637a57e17c404d9d6
+SHA512:
+  metadata.gz: a078c9a5e63f20059d6148e48356efead6f2520f47d0225c94a33cf3721b5294f9f6e893e166e53fb4a4609f3e5c62dee9872ea023d460d0731581d812eeb9bf
+  data.tar.gz: b7595d1ab8c6c7df4506e590a19a6ab0653d27edcfec4a1eef1764c21e3d9eb2d2edaffae6beff4bbf09465b2d84d029bf15c89a7a5cb944104e712543ea5347

data/.github/workflows/main.yml

@@ -0,0 +1,35 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Run unit tests and code linting
+      run: |
+        gem install bundler -v 2.2.9
+        bundle install
+        bundle exec rake
+        bundle exec yard
+
+    - name: Deploy documentation
+      if: github.ref == 'refs/heads/main'
+      uses: crazy-max/ghaction-github-pages@v2.2.0
+      with:
+        target_branch: gh-pages
+        build_dir: doc
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+    - name: Release Gem
+      if: contains(github.ref, 'refs/tags/v')
+      uses: dawidd6/action-publish-gem@v1.2.0
+      with:
+        github_token: ${{secrets.GITHUB_TOKEN}}
+        api_key: ${{secrets.RUBYGEMS_API_KEY}}

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/ClassLength:
+  Max: 250
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+    - remotus.gemspec
+    - lib/remotus/ssh_connection.rb
+
+Metrics/AbcSize:
+  Max: 25
+  Exclude:
+    - lib/remotus/ssh_connection.rb
+
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - lib/remotus/ssh_connection.rb
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/remotus/ssh_connection.rb
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - lib/remotus/ssh_connection.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-03-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in remotus.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    remotus (0.1.0)
+      connection_pool (~> 2.2)
+      net-scp (~> 3.0)
+      net-ssh (~> 6.1)
+      winrm (~> 2.3)
+      winrm-fs (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    builder (3.2.4)
+    connection_pool (2.2.3)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    ffi (1.15.0)
+    gssapi (1.3.1)
+      ffi (>= 1.0.1)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    httpclient (2.8.3)
+    little-plugger (1.1.4)
+    logging (2.3.0)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.14)
+    multi_json (1.15.0)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    nori (2.6.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    rubyntlm (0.6.3)
+    rubyzip (2.3.0)
+    unicode-display_width (2.0.0)
+    winrm (2.3.6)
+      builder (>= 2.1.2)
+      erubi (~> 1.8)
+      gssapi (~> 1.2)
+      gyoku (~> 1.0)
+      httpclient (~> 2.2, >= 2.2.0.2)
+      logging (>= 1.6.1, < 3.0)
+      nori (~> 2.0)
+      rubyntlm (~> 0.6.0, >= 0.6.3)
+    winrm-fs (1.3.5)
+      erubi (~> 1.8)
+      logging (>= 1.6.1, < 3.0)
+      rubyzip (~> 2.0)
+      winrm (~> 2.0)
+    yard (0.9.26)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  remotus!
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rake (~> 0.5)
+  rubocop-rspec (~> 2.2)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.2.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Matthew Newell
+
+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 @@
+# Remotus
+
+Remotus provides a simple ruby interface for pooling remote SSH and WinRM connections and managing remote credentials. Custom authentication stores may be added to allow remote credentials to be automatically retrieved.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'remotus'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install remotus
+
+## Usage
+
+```ruby
+# Initialize a new connection pool to remotehost.local and auto-determine whether to use SSH or WinRM
+connection = Remotus.connect("remotehost.local")
+
+# Initialize a new connection pool to remotehost.local with a defined protocol and port
+connection = Remotus.connect("remotehost.local", proto: :ssh, port: 2222)
+
+# Create a credential for the new connection pool
+connection.credential = Remotus::Auth::Credential.new("username", "password")
+
+# Run a command on the remote host
+result = connection.run("hostname")
+
+result.command
+# => "hostname"
+
+result.stdout
+# => "remotehost.local\n"
+
+result.stderr
+# => ""
+
+result.output
+# => "remotehost.local\n"
+
+result.exit_code
+# => 0
+
+# Run a command on the remote host with sudo (Linux only, requires password to be specified)
+result = connection.run("ls /root", sudo: true)
+
+# Run a script on the remote host
+connection.run_script("/local/script.sh", "/remote/path/script.sh")
+
+# Run a script on the remote host with arguments
+connection.run_script("/local/script.sh", "/remote/path/script.sh", "arg1", "arg2")
+
+# Upload a file to the remote host
+connection.upload("/local/file.txt", "/remote/path/file.txt")
+
+# Download a file from the remote host
+connection.download("/remote/path/file.txt", "/local/file.txt")
+```
+
+Full documentation is available in the [Remotus GitHub Pages](https://wheatevo.github.io/remotus/).
+
+### Extending Remotus
+
+Remotus may be extended by adding more authentication stores to gather remote credential data from centralized services.
+
+#### Authentication Stores
+
+More authentication stores may be added by creating a new class that inherits from `Remotus::Auth::Store` and implementing the `credential` method. The `credential` method should receive a `Remotus::SshConnection` or `Remotus::WinrmConnection` and an options hash and return a `Remotus::Auth::Credential` or `nil` if no credential can be found.
+
+Once a new authentication store has been defined, ensure it is used by Remotus by adding it to `Remotus::Auth.stores`.
+
+```ruby
+# Define a new authentication store that returns "<hostname>_password" for any connection
+#
+# This is for demonstration purposes only, please do not use any password with your hostname or "password" in it :)
+require "remotus"
+
+class SimpleStore < Remotus::Auth::Store
+  def credential(connection, **options)
+    "#{connection.host}_password"
+  end
+end
+
+# Add the authentication store to the array of existing authentication stores
+Remotus::Auth.stores << SimpleStore.new
+
+# Use the authentication store
+connection = Remotus.connect("remotehost.local", proto: :ssh)
+Remotus::Auth.credential(connection)
+# => "remotehost.local_password"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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/wheatevo/remotus.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "remotus"
+
+# 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/remotus.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "remotus/version"
+require "remotus/logger"
+require "remotus/pool"
+require "remotus/auth"
+
+# Contains classes and methods for creating remote connections and running commands
+module Remotus
+  #
+  # Creates/gets a host pool for the host that can be used to perform remote operations.
+  # After creation, the host pool will persist for future connections.
+  #
+  # @param [String] host hostname
+  # @param [Hash] options options hash
+  # @option options [Integer] :size number of connections in the pool
+  # @option options [Integer] :timeout amount of time to wait for a connection from the pool
+  # @option options [Integer] :port port to use for the connection
+  # @option options [Symbol]  :proto protocol to use for the connection (:winrm, :ssh), must be specified if port is specified
+  #
+  # @return [Remotus::HostPool] Newly created or retrieved host pool
+  #
+  def self.connect(host, **options)
+    Remotus::Pool.connect(host, **options)
+  end
+
+  #
+  # Number of host pools in the connection pool
+  #
+  # @return [Integer] number of host pools
+  #
+  def self.count
+    Remotus::Pool.count
+  end
+
+  #
+  # Removes all host pools from the pool in a thread-safe manner
+  #
+  # @return [Integer] number of host pools removed
+  #
+  def self.clear
+    Remotus::Pool.clear
+  end
+
+  #
+  # Checks if a remote port is open
+  #
+  # @param [String] host remote host
+  # @param [Integer] port remote port
+  # @param [Integer] timeout amount of time to wait in seconds
+  #
+  # @return [Boolean] true if port is open, false otherwise
+  #
+  def self.port_open?(host, port, timeout: 1)
+    logger.debug { "Checking if #{host}:#{port} is accessible" }
+    Socket.tcp(host, port, connect_timeout: timeout) { true }
+  rescue StandardError
+    logger.debug { "#{host}:#{port} is inaccessible" }
+    false
+  end
+
+  #
+  # Determine remote host type by checking common ports
+  #
+  # @param [String] host hostname
+  # @param [Integer] timeout amount of time to wait in seconds
+  #
+  # @return [Symbol, nil] :ssh, :winrm, or nil if it cannot be determined
+  #
+  def self.host_type(host, timeout: 1)
+    return :ssh if port_open?(host, SshConnection::REMOTE_PORT, timeout: timeout)
+
+    return :winrm if port_open?(host, WinrmConnection::REMOTE_PORT, timeout: timeout)
+
+    nil
+  end
+
+  #
+  # Gets the remotus logger
+  #
+  # @return [Remotus::Logger] current logger
+  #
+  def self.logger
+    @logger ||= Remotus::Logger.new($stdout, level: Logger::INFO)
+  end
+
+  #
+  # Sets the remotus logger
+  #
+  # @param [::Logger] logger logger to set
+  #
+  def self.logger=(logger)
+    if logger.nil?
+      self.logger.level = Logger::FATAL
+      return self.logger
+    end
+    @logger = logger
+  end
+
+  #
+  # Gets the remotus log formatter
+  #
+  # @return [::Logger::Formatter] current log formatter
+  #
+  def self.log_formatter
+    @log_formatter ||= logger.formatter
+  end
+
+  #
+  # Sets the remotus log formatter
+  #
+  # @param [::Logger::Formatter] log_formatter new log formatter
+  #
+  def self.log_formatter=(log_formatter)
+    @log_formatter = log_formatter
+    logger.formatter = log_formatter
+  end
+
+  # Generic base class for Remotus errors
+  class Error < StandardError; end
+
+  # Failed to obtain PTY during SSH connection
+  class PtyError < Error; end
+
+  # Failed to determine remote node host type
+  class HostTypeDeterminationError < Error; end
+
+  # Failed to authenticate to remote host
+  class AuthenticationError < Error; end
+
+  # Raised when a RemoteCommand::Result has an error
+  class ResultError < Error; end
+
+  # Raised when a derived class is missing an override method
+  class MissingOverride < Error; end
+
+  # Failed to find credential in credential store
+  class MissingCredential < Error; end
+
+  # Failed to find credential password when executing sudo command
+  class MissingSudoPassword < Error; end
+end