ssh_tunnels 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba405495fb6506f5a69ac1fb1e222ff0b471a6276914f82c46b6960c4fa3796c
-  data.tar.gz: fe87c9476685c2d87d7843f098260875561399967c0f504081f92e844a58e4e4
+  metadata.gz: 4e4fe888d25ffab2361eb1978eab7e3c1a64e986388860c82a3aba981603afc1
+  data.tar.gz: a352882082070c6abd2faecbf0ca2b3e771cd88bd51107ee2d0d539853142561
 SHA512:
-  metadata.gz: ded2e91fc8fce982c29a31a7da1e37e0ea3b009407c215dc6bfd4f0a6c451a22e639630a2acbf1f5776de3d8b20337857658e44ddb86554b61c67b86632b27e0
-  data.tar.gz: 7827c2125fb9ea315d0e70629c01fde527bba7b027fa8c81b899caab12cb83c465fdaa937351272ded5e0a8b71c423deb3c8f455fda4aeff8c41eeaf44c0ae11
+  metadata.gz: 3899497544ac7e01a40605dcef63d9d3ddd0721eb36a0f1b4892f64769f39b185ee5aa70982123040c24e479366e830a04be416cf2edee0c2fb15a176bf121b9
+  data.tar.gz: 572f38e2af5076cec0604164ff59278296dec1ba7ce2e0e6d4635acc2ae122a3701f6fa86b86fb23590ed2d795858f5272e41835cc082f7386ce285ce9469197

data/Gemfile.lock

@@ -1,42 +1,44 @@
 PATH
   remote: .
   specs:
-    ssh_tunnels (0.1.1)
+    ssh_tunnels (0.2.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)
+    ast (2.4.2)
+    concurrent-ruby (1.2.3)
+    curses (1.4.4)
+    diff-lcs (1.5.1)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
-    net-ssh (6.1.0)
+    net-ssh (7.2.3)
     net-ssh-gateway (2.0.0)
       net-ssh (>= 4.0.0)
-    paint (2.2.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    paint (2.3.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       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)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (0.86.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
@@ -46,13 +48,13 @@ GEM
       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)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.13.0)
+    strong_versions (0.4.5)
+      i18n (>= 0.5)
       paint (~> 2.0)
-    unicode-display_width (1.7.0)
+    unicode-display_width (1.8.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,8 @@
 # SshTunnels
 
-Interactive _SSH_ tunnel management.
+Interactive _SSH_ tunnel management. Console UI powered by [ncurses](https://invisible-island.net/ncurses/).
+
+![example](doc/demo.png)
 
 ## Installation
 
@@ -14,14 +16,64 @@ gem install ssh_tunnels
 ssh_tunnels -c config.yml
 ```
 
+Alternatively, default to using `~/.ssh_tunnels.yml` for configuration:
+
+```bash
+ssh_tunnels
+```
+
 ## Configuration
 
+### Gateways
+
+There are two ways to configure an SSH gateway. Both can be used together, but at least one must be defined:
+
+1. Define a `default_gateway` section in your configuration file.
+1. Define a `gateways` section in your conifguration file.
+
+The `default_gateway` is a map containing these keys:
+
+* `host`: hostname or IP address of gateway (required).
+* `port`: SSH port on gateway (default: `22`).
+* `user`: Username on gateway to connect with (default: `$USER`).
+
+The `gateways` section is also a map, but each key represents a named gateway, and each gateway is configured using the same parameters as `default_gateway`.
+
+Each named gateway can be referred to in the `gateway` field for each tunnel.
+
 ```yaml
 # config.yml
 
-gateway:
+default_gateway:
   host: gateway.example.com
-  port: 22
+
+gateways:
+  aws:
+    host: 111.111.111.111
+    user: ubuntu
+  azure:
+    host: 222.222.222.222
+    user: william
+```
+
+### Tunnels
+
+The `tunnels` section is a map where each key represents a named tunnel. Each tunnel can be configured using the following parameters:
+
+* `host`: The remote host to connect to from the gateway.
+* `remote`: The remote port to use for forwarding.
+* `local`: The local port to bind to (defaults to the `remote` port).
+
+```yaml
+# config.yml
+
+default_gateway:
+  host: gateway.example.com
+
+gateways:
+  aws:
+    host: 111.111.111.111
+    user: ubuntu
 
 tunnels:
   my_host:
@@ -29,6 +81,7 @@ tunnels:
     host: my.host.example.com
     remote: 4567
   other_host:
+    gateway: aws
     local: 1111
     host: other.host.example.com
     remote: 5555

data/bin/ssh_tunnels

@@ -20,24 +20,40 @@ OptionParser.new do |opts|
   end
 end.parse!
 
-unless options[:config_path]
-  warn('Must provide configuration path. See --help')
-  exit 1
-end
+config_path = options.fetch(:config_path, File.expand_path('~/.ssh_tunnels.yml'))
 
-unless File.exist?(options[:config_path])
-  warn("Unable to locate configuration file: #{options[:config_path]}")
+unless File.exist?(config_path)
+  warn("Unable to locate configuration file: #{config_path}")
   exit 1
 end
 
-config = YAML.safe_load(File.read(options[:config_path]))
+config = YAML.safe_load(File.read(config_path))
 
 begin
-  gateway = config.fetch('gateway')
+  default_gateway = config.fetch('default_gateway', nil)
+  if !config.key?('tunnels')
+    warn('Configuration file must provide `tunnels` section. Exiting.')
+    exit 1
+  end
+
+  gateways = config.fetch('gateways', {})
+
   tunnels = config.fetch('tunnels')
-rescue KeyError
-  warn('Configuration file must provide `gateway` and `tunnels` sections.')
-  exit 1
+  error = false
+  tunnels.each do |key, tunnel|
+    if tunnel.key?('gateway') && !gateways.key?(tunnel.fetch('gateway'))
+      error = true
+      warn("Tunnel `#{key}` references unknown gateway `#{tunnel.fetch('gateway')}`")
+    elsif !tunnel.key?('gateway') && default_gateway.nil?
+      error = true
+      warn("Tunnel `#{key}` must provide `gateway` key or define a top-level `default_gateway` configuration.")
+    end
+  end
+
+  if error
+    warn("Configuration errors detected. Exiting.")
+    exit 1
+  end
 end
 
 user = ENV.fetch('USER')
@@ -47,6 +63,11 @@ puts
 
 begin
   tunnels = tunnels.map do |name, tunnel_config|
+    gateway = if tunnel_config.key?('gateway')
+                gateways.fetch(tunnel_config.fetch('gateway'))
+              else
+                default_gateway
+              end
     SshTunnels::Tunnel.new(name, user, tunnel_config, gateway, passphrase)
   end
   ui = SshTunnels::UI.new(tunnels)

data/lib/ssh_tunnels/tunnel.rb

@@ -27,11 +27,11 @@ module SshTunnels
     end
 
     def open
-      @connection = Net::SSH::Gateway.new(@gateway.fetch('host'), @user, options)
+      @connection = Net::SSH::Gateway.new(@gateway.fetch('host'), @gateway.fetch('user', @user), options)
       @connection.open(remote_host, remote_port, local_port)
-    rescue Errno::EADDRINUSE => e
-      @error = e.to_s
+    rescue StandardError => e
       shutdown
+      raise
     end
 
     def active?
@@ -41,7 +41,7 @@ module SshTunnels
     end
 
     def shutdown
-      @connection.shutdown!
+      @connection&.shutdown!
     end
 
     private
@@ -55,14 +55,14 @@ module SshTunnels
     end
 
     def local_port
-      @config.fetch('local_port')
+      @config.fetch('local_port', remote_port)
     end
 
     def options
       {
         keepalive: true,
         keepalive_interval: 5,
-        port: @gateway.fetch('port'),
+        port: @gateway.fetch('port', 22),
         passphrase: @passphrase
       }
     end

data/lib/ssh_tunnels/ui.rb

@@ -96,7 +96,11 @@ module SshTunnels
       else
         status("Connecting: #{tunnel}")
       end
-      tunnel.toggle
+      begin
+        tunnel.toggle
+      rescue StandardError => e
+        status("Error: #{e}")
+      end
     end
 
     def tunnel_color(tunnel)

data/lib/ssh_tunnels/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssh_tunnels
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -100,6 +100,7 @@ files:
 - bin/console
 - bin/setup
 - bin/ssh_tunnels
+- doc/demo.png
 - lib/ssh_tunnels.rb
 - lib/ssh_tunnels/tunnel.rb
 - lib/ssh_tunnels/ui.rb