ssh_tunnels 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae788942bb584a3aeb278a81eff1e25aff8861668835fc4844bf3ce32a58d3c8
+  data.tar.gz: b8adc0bf535fa0c219887a69a640dde3d32503f119b2c8b7c8e83c9e4313749c
+SHA512:
+  metadata.gz: 63367bcdd582fdbfd353f450b8c702930f30473f735a6d33dc6b12a44aaf6529c512756c7becaa061d2c0a51a0ba7b21ed53a40cdd0cb597f803b2af78a66147
+  data.tar.gz: 6a56b3b03faa392aaa30b0e5cecae91eab88633dd447663c980ee0e37e976b97e8676e43073271b6f463e3457d3d35e3204c5bbf66bf8ef3e5b7b244fc5446e3

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    ssh_tunnels (0.1.0)
+      curses (~> 1.3)
+      net-ssh-gateway (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    concurrent-ruby (1.1.6)
+    curses (1.3.2)
+    diff-lcs (1.4.2)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    net-ssh (6.1.0)
+    net-ssh-gateway (2.0.0)
+      net-ssh (>= 4.0.0)
+    paint (2.2.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    strong_versions (0.4.4)
+      i18n (>= 0.5.0)
+      paint (~> 2.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.9)
+  rubocop (~> 0.86.0)
+  ssh_tunnels!
+  strong_versions (~> 0.4.4)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bob Farrell
+
+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/Makefile

@@ -0,0 +1,5 @@
+.PHONY: test
+test:
+	bundle exec rspec
+	bundle exec rubocop
+	bundle exec strong_versions

data/README.md

@@ -0,0 +1,43 @@
+# SshTunnels
+
+Interactive _SSH_ tunnel management.
+
+## Installation
+
+```bash
+gem install ssh_tunnels
+```
+
+## Usage
+
+```bash
+ssh_tunnels -c config.yml
+```
+
+## Configuration
+
+```yaml
+# config.yml
+
+gateway:
+  host: gateway.example.com
+  port: 22
+
+tunnels:
+  my_host:
+    local: 1234
+    host: my.host.example.com
+    remote: 4567
+  other_host:
+    local: 1111
+    host: other.host.example.com
+    remote: 5555
+```
+
+## Contributing
+
+Pull requests are welcome.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path(File.join(__dir__, '..', 'lib'))
+
+require 'ssh_tunnels'
+
+require 'optparse'
+require 'io/console'
+require 'yaml'
+
+options = {}
+USAGE = 'Usage: ssh_tunnels [options]'
+
+OptionParser.new do |opts|
+  opts.banner = USAGE
+
+  opts.on('-c', '--config PATH', 'Configuration file path') do |config|
+    options[:config_path] = config
+  end
+end.parse!
+
+unless options[:config_path]
+  warn('Must provide configuration path. See --help')
+  exit 1
+end
+
+unless File.exist?(options[:config_path])
+  warn("Unable to locate configuration file: #{options[:config_path]}")
+  exit 1
+end
+
+config = YAML.safe_load(File.read(options[:config_path]))
+
+begin
+  gateway = config.fetch('gateway')
+  tunnels = config.fetch('tunnels')
+rescue KeyError
+  warn('Configuration file must provide `gateway` and `tunnels` sections.')
+  exit 1
+end
+
+user = ENV.fetch('USER')
+print 'Enter SSH key passphrase (leave blank if not required): '
+passphrase = STDIN.noecho(&:gets).chomp
+puts
+
+begin
+  tunnels = tunnels.map do |name, tunnel_config|
+    SshTunnels::Tunnel.new(name, user, tunnel_config, gateway, passphrase)
+  end
+  ui = SshTunnels::UI.new(tunnels)
+  ui.run
+rescue Interrupt
+  puts 'Interrupt detected.'
+  ui.shutdown
+end

data/lib/ssh_tunnels.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'curses'
+require 'net/ssh/gateway'
+
+require 'ssh_tunnels/version'
+require 'ssh_tunnels/tunnel'
+require 'ssh_tunnels/ui'
+
+module SshTunnels
+  class Error < StandardError; end
+  class UserQuit < Error; end
+end

data/lib/ssh_tunnels/tunnel.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module SshTunnels
+  # SSH Tunnel
+  class Tunnel
+    attr_reader :name, :error
+
+    def initialize(name, user, config, gateway, passphrase)
+      @name = name
+      @user = user
+      @config = config
+      @passphrase = passphrase
+      @config = config
+      @gateway = gateway
+      @connection = nil
+    end
+
+    def to_s
+      base = "#{local_port}:#{remote_host}:#{remote_port}"
+      return base unless @error
+
+      "#{base} (#{@error})"
+    end
+
+    def toggle
+      active? ? shutdown : open
+    end
+
+    def open
+      @connection = Net::SSH::Gateway.new(@gateway.fetch('host'), @user, options)
+      @connection.open(remote_host, remote_port, local_port)
+    rescue Errno::EADDRINUSE => e
+      @error = e.to_s
+      shutdown
+    end
+
+    def active?
+      return false if @connection.nil?
+
+      @connection.active?
+    end
+
+    def shutdown
+      @connection.shutdown!
+    end
+
+    private
+
+    def remote_host
+      @config.fetch('host')
+    end
+
+    def remote_port
+      @config.fetch('remote_port')
+    end
+
+    def local_port
+      @config.fetch('local_port')
+    end
+
+    def options
+      {
+        keepalive: true,
+        keepalive_interval: 5,
+        port: @gateway.fetch('port'),
+        passphrase: @passphrase
+      }
+    end
+  end
+end

data/lib/ssh_tunnels/ui.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module SshTunnels
+  # rubocop:disable Metrics/ClassLength
+  # User Interface
+  class UI
+    def initialize(tunnels)
+      @tunnels = tunnels
+    end
+
+    def setup
+      Curses.init_screen
+      Curses.start_color
+      Curses.init_pair(1, Curses::COLOR_WHITE, Curses::COLOR_BLACK)
+      Curses.init_pair(2, Curses::COLOR_BLUE, Curses::COLOR_BLACK)
+      Curses.init_pair(3, Curses::COLOR_GREEN, Curses::COLOR_BLACK)
+      Curses.init_pair(4, Curses::COLOR_CYAN, Curses::COLOR_BLACK)
+      Curses.init_pair(5, Curses::COLOR_RED, Curses::COLOR_BLACK)
+      Curses.timeout = 1000
+      Curses.curs_set(0)
+      Curses.noecho
+    end
+
+    def run
+      setup
+      monitor
+    rescue Net::SSH::Disconnect, Errno::ECONNRESET => e
+      shutdown("Error encountered: #{e}")
+    ensure
+      Curses.close_screen
+    end
+
+    def shutdown(error = nil)
+      Curses.close_screen
+      puts error unless error.nil?
+      puts 'Shutting down connections.'
+      @tunnels.select(&:active?).each(&:shutdown)
+      puts 'Shutdown complete.'
+    end
+
+    private
+
+    def monitor
+      loop do
+        @tunnels.each_with_index do |tunnel, index|
+          display_tunnel(tunnel, index)
+        end
+        refresh
+      end
+    rescue UserQuit
+      shutdown
+    end
+
+    def refresh
+      display_usage
+      window.refresh
+      input = window.getch
+      process_input(input) unless input.nil?
+      clean_status if @status_time && Time.now.utc - @status_time > 2.5
+    end
+
+    def window
+      @window ||= Curses.stdscr
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def display_tunnel(tunnel, index)
+      window.setpos(index + 2, 2)
+      window.attrset(color(:white))
+      window.addstr("#{index + 1}. ")
+      window.attrset(tunnel_color(tunnel))
+      window.addstr("#{tunnel.name} ")
+      window.attrset(color(:cyan))
+      window.addstr(tunnel.to_s)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def display_usage
+      window.setpos(@tunnels.size + 3, 2)
+      window.attrset(color(:cyan))
+      message = "[1-#{@tunnels.size}] to connect/disconnect. Press 'q' to quit."
+      window.addstr(message)
+    end
+
+    def process_input(input)
+      raise UserQuit if input == 'q'
+      return status("Unrecognized input: #{input}") unless input.is_a?(String) && input =~ /\A\d+\Z/
+
+      tunnel = @tunnels[input.to_i - 1]
+      return status("Unrecognized tunnel: #{input}") if tunnel.nil?
+
+      if tunnel.active?
+        status("Disconnecting: #{tunnel}")
+      else
+        status("Connecting: #{tunnel}")
+      end
+      tunnel.toggle
+    end
+
+    def tunnel_color(tunnel)
+      return color(:red) if tunnel.error
+
+      tunnel.active? ? color(:green) : color(:blue)
+    end
+
+    def status(message)
+      clean_status
+      @status_time = Time.now.utc
+      window.setpos(*status_coordinates)
+      window.attrset(color(:white))
+      window.addstr(message)
+      window.refresh
+    end
+
+    def clean_status
+      y, x = status_coordinates
+      window.setpos(y, x)
+      window.attrset(color(:white))
+      window.addstr(' ' * (Curses.cols - x))
+    end
+
+    def status_coordinates
+      [@tunnels.size + 5, 2]
+    end
+
+    def color(name)
+      Curses.color_pair(
+        {
+          white: 1,
+          blue: 2,
+          green: 3,
+          cyan: 4,
+          red: 5
+        }.fetch(name)
+      )
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end

data/lib/ssh_tunnels/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SshTunnels
+  VERSION = '0.1.0'
+end

data/ssh_tunnels.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ssh_tunnels/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ssh_tunnels'
+  spec.version       = SshTunnels::VERSION
+  spec.authors       = ['Bob Farrell']
+  spec.email         = ['git@bob.frl']
+
+  spec.summary       = 'Interactive SSH tunnel management'
+  spec.description   = 'Conveniently manage numerous SSH tunnels with ncurses'
+  spec.homepage      = 'https://github.com/bobf/ssh_tunnels'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/bobf/ssh_tunnels/blob/master/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = 'ssh_tunnels'
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'curses', '~> 1.3'
+  spec.add_runtime_dependency 'net-ssh-gateway', '~> 2.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 0.86.0'
+  spec.add_development_dependency 'strong_versions', '~> 0.4.4'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: ssh_tunnels
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Farrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: net-ssh-gateway
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+- !ruby/object:Gem::Dependency
+  name: strong_versions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+description: Conveniently manage numerous SSH tunnels with ncurses
+email:
+- git@bob.frl
+executables:
+- ssh_tunnels
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/ssh_tunnels
+- lib/ssh_tunnels.rb
+- lib/ssh_tunnels/tunnel.rb
+- lib/ssh_tunnels/ui.rb
+- lib/ssh_tunnels/version.rb
+- ssh_tunnels.gemspec
+homepage: https://github.com/bobf/ssh_tunnels
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bobf/ssh_tunnels
+  source_code_uri: https://github.com/bobf/ssh_tunnels
+  changelog_uri: https://github.com/bobf/ssh_tunnels/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Interactive SSH tunnel management
+test_files: []