tunneler 0.0.1

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+ruby "1.9.3"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nels Broberg
+
+MIT License
+
+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,54 @@
+Tunneler
+=========
+
+Tunneler is a Ruby command line interface for multi-hop SSH tunneling.
+
+  - SCP files through a bastion host
+  - Execute remote commands through a bastion host
+  - SSH through a bastion host using native terminal
+
+Version
+----
+
+0.0.1
+
+Installation
+--------------
+
+```sh
+gem install tunneler
+```
+
+Example Command-Line Usage
+--------------
+
+```sh
+tunneler --bastion-host 150.1.2.3 --destination-host 151.2.3.4 ssh
+tunneler --bastion-host 150.1.2.3 --destination-host 151.2.3.4 scp local_file destination_file
+tunneler --bastion-host 150.1.2.3 -d 151.2.3.4 execute 'whoami'
+```
+
+Example Gem Usage
+--------------
+
+```ruby
+require "tunneler"
+
+# Create SSH tunnel
+tunnel = SshTunnel.new(bastion_user, bastion_host, {:keys => [bastion_key]})
+
+# Establish remote connection
+destination_host_connection = tunnel.remote(destination_user, destination_host, {:keys => [destination_key]})
+
+# Upload file to destination host via tunnel
+destination_host_connection.scp(local_file_path, destination_file_path)
+
+# Execute common on destination host via tunnel
+response = destination_host_connection.ssh(command)
+```
+
+
+License
+----
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec 'irb -I lib -r provisioner.rb'
+end

data/bin/tunneler

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "tunneler"
+
+tunneler_cli = Tunneler::CommandLine.new
+tunneler_cli.run

data/lib/tunneler.rb

@@ -0,0 +1,26 @@
+require "net/scp"
+require "net/ssh/gateway"
+require "trollop"
+require "singleton"
+require "time"
+
+module Tunneler
+
+  APPLICATION_ROOT = File.expand_path("..",File.dirname(__FILE__))
+
+  def self.debug
+    Config.instance.debug
+  end
+
+  def self.debug=(boolean)
+    require "debugger" if boolean
+    Config.instance.debug = boolean
+  end
+
+  def self.log(message, level=:info)
+    Logger.log(message, level)
+  end
+
+  Gem.find_files("tunneler/**/*.rb").each { |path| require path }
+  
+end

data/lib/tunneler/cli.rb

@@ -0,0 +1,123 @@
+module Tunneler
+  class CommandLine
+
+    def run
+      setup_options
+      subcommand = process_sub_command
+      if @strict_host_checking
+        @strict_host_checking_options = ""
+      else
+        @strict_host_checking_options = "-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
+      end
+
+      Tunneler.debug = @debug
+
+      if subcommand == "ssh"
+        ssh
+      elsif subcommand == "scp"
+        local_file_path = ARGV.shift
+        destination_file_path = ARGV.shift
+        if local_file_path && destination_file_path
+          scp(local_file_path, destination_file_path)
+        end
+      elsif subcommand == "execute"
+        if command = ARGV.shift
+          execute(command)
+        end
+      end
+    end
+
+    def execute(command)
+      tunnel = SshTunnel.new(@bastion_user, @bastion_host, {:keys => [@bastion_key]})
+      destination_host_connection = tunnel.remote(@destination_user, @destination_host, {:keys => [@destination_key]})
+      Tunneler.log "Executing remote command '#{command}' on '#{@destination_host}' via '#{@bastion_host}'..."
+      Tunneler.log destination_host_connection.ssh(command)
+    end
+
+    def scp(local_file_path, destination_file_path)
+      tunnel = SshTunnel.new(@bastion_user, @bastion_host, {:keys => [@bastion_key]})
+      destination_host_connection = tunnel.remote(@destination_user, @destination_host, {:keys => [@destination_key]})
+      Tunneler.log "Uploading '#{local_file_path}' to '#{destination_file_path}' on '#{@destination_host}' via '#{@bastion_host}'..."
+      destination_host_connection.scp(local_file_path, destination_file_path)
+    end
+
+    def ssh
+      destination_key_filename = Pathname.new(@destination_key).basename
+      commands = [
+        "scp -i #{@bastion_key} #{@destination_key} #{@bastion_user}@#{@bastion_host}:",
+        "ssh -i #{@bastion_key} #{@strict_host_checking_options} -A -t -l #{@bastion_user} #{@bastion_host} -L #{DEFAULT_LOCAL_TUNNEL_PORT}:localhost:#{DEFAULT_LOCAL_TUNNEL_PORT} ssh #{@strict_host_checking_options} -A -t -i /home/#{@bastion_user}/#{destination_key_filename} -l #{@destination_user} #{@destination_host} -L #{DEFAULT_LOCAL_TUNNEL_PORT}:localhost:#{DEFAULT_LOCAL_TUNNEL_PORT}",
+      ]
+      print "Opening ssh connection to '#{@destination_host}' via '#{@bastion_host}'"
+      open_terminal(commands.join(" ; "))
+      # remove the key as soon as authentication has occurred
+      # system "ssh -i #{@bastion_key} #{@strict_host_checking_options} -A -t -l #{@bastion_user} #{@bastion_host} -e 'rm /home/#{@bastion_user}/#{destination_private_key_filename}'"
+    end
+
+    def open_terminal(command)
+      os = RbConfig::CONFIG['host_os']
+      case os
+      when /darwin|mac os/
+        terminal = ENV['TERM_PROGRAM']
+        if terminal =~ /iTerm/
+          local_command = "osascript -e 'tell application \"System Events\" to keystroke \"t\" using command down' -e 'tell application \"iTerm\" to tell session -1 of current terminal to write text \"#{command}\"'"
+        elsif terminal =~ /Terminal/
+          local_command = "osascript -e 'tell application \"Terminal\" to activate' -e 'tell application \"System Events\" to tell process \"Terminal\" to keystroke \"t\" using command down' -e 'tell application \"Terminal\" to do script \"#{command}\" in selected tab of the front window'"
+        else
+          Tunneler.log "Terminal '#{terminal}' not supported", :cli
+          exit
+        end
+      when /linux/
+        local_command = "gnome-terminal -e '#{command}'"
+      else
+        Tunneler.log "SSH option not available in #{os.inspect}", :warn
+        return
+      end
+      system(local_command)
+    end
+
+    def setup_options
+      help = self.class.help + "\nParameters:"
+      sub_commands = self.class.sub_commands
+      options = Trollop::options(ARGV) do
+        banner help
+        opt :bastion_host, "Tunneler host", :type => :string, :required => true
+        opt :bastion_user, "Tunneler SSH user", :type => :string, :default => DEFAULT_SSH_USER
+        opt :bastion_key, "Tunneler SSH key path", :type => :string, :default => DEFAULT_SSH_KEY_PATH
+        opt :destination_host, "Destination host", :type => :string, :required => true
+        opt :destination_user, "Destination SSH user", :type => :string, :default => DEFAULT_SSH_USER
+        opt :destination_key, "Destination SSH key path", :type => :string, :default => DEFAULT_SSH_KEY_PATH
+        opt :strict_host_checking, "Enable SSH Strict Host Checking", :default => false
+        opt :debug, "Enable debug mode"
+        stop_on sub_commands
+      end
+      options.each { |name, value| instance_variable_set("@#{name}", value) }
+    end
+
+    def self.help
+      "Tunneler CLI - ssh or scp through bastion host tunnel\n\n" +
+      "Available subcommands: #{self.sub_commands.join(', ')}\n\n" +
+      "Command syntax: tunneler <parameters> <subcommand>\n" + 
+      "Examples:       tunneler -b 120.1.2.3 -d 121.2.3.4 ssh\n" +
+      "                tunneler -b 120.1.2.3 -d 121.2.3.4 scp local_file destination_file\n" +
+      "                tunneler -b 120.1.2.3 -d 121.2.3.4 execute whoami\n"
+    end
+
+    def self.sub_commands
+      ["ssh", "scp", "execute"]
+    end
+
+    def process_sub_command
+      sub_command = ARGV.shift
+      unless self.class.sub_commands.include?(sub_command)
+        if sub_command
+          Tunneler.log "Invalid subcommand '#{sub_command}'", :cli
+        else
+          Tunneler.log "Please specify --help for command information", :cli
+        end
+        exit
+      end
+      sub_command
+    end
+
+  end
+end

data/lib/tunneler/config.rb

@@ -0,0 +1,21 @@
+module Tunneler
+
+  DEFAULT_SSH_USER = ENV['USER']
+
+  DEFAULT_SSH_KEY_PATH = "#{ENV['HOME']}/.ssh/id_rsa"
+
+  DEFAULT_LOCAL_TUNNEL_PORT = 9997
+
+  class Config
+
+    include Singleton
+
+    attr_accessor :debug
+
+    def initialize
+      @debug = false
+    end
+
+  end
+
+end

data/lib/tunneler/logger.rb

@@ -0,0 +1,43 @@
+module Tunneler
+  class Logger
+    include Singleton
+  
+    @@session = ""
+
+    LOG_FILE = "#{APPLICATION_ROOT}/log"
+
+    def self.create_log_file
+      unless File.exist?(LOG_FILE)
+        File.open(LOG_FILE, "w") {}
+      end
+    end
+
+    def self.log(message, level)
+      message = message.to_s
+      self.log_to_file(message, level) unless level == :cli
+      self.log_to_session(message)
+      puts message unless level == :debug && !Tunneler.debug
+    end
+
+    def self.log_to_file(message, level)
+      self.create_log_file
+      @@log ||= File.open(LOG_FILE, "a")
+      log_entry = [Time.now.utc.iso8601, level.upcase, message.strip.strip]
+      @@log.puts(log_entry.join("\t"))
+    end
+
+    def self.log_to_session(message)
+      @@session << message + "\n"
+    end
+
+    def self.session
+      @@session
+    end
+
+    def self.truncate_session
+      session = @@session
+      @@session = ""
+      session
+    end
+  end
+end

data/lib/tunneler/ssh.rb

@@ -0,0 +1,85 @@
+module Tunneler
+  class Ssh
+
+    SSH_READY_TIMEOUT = 70
+    SSH_CONNECTIVITY_TIMEOUT = 15
+    ACCEPTABLE_CONNECTIVITY_ERRORS = [Errno::ECONNREFUSED]
+
+    SSH_COMMAND_TIMEOUT = 300
+
+    SCP_OPTIONS = { :recursive => true, :compression => "zlib" }
+
+    def initialize(user, host, options={})
+      @user = user
+      @host = host
+      @options = self.class.merge_options(options)
+    end
+
+    def self.default_options
+      {
+        :paranoid => false,
+        :keys => [DEFAULT_SSH_KEY_PATH],
+        :timeout => self::SSH_COMMAND_TIMEOUT,
+      }
+    end
+
+    def self.merge_options(options={})
+      if options.empty?
+        Ssh.default_options
+      else
+        Ssh.default_options.merge(options)
+      end
+    end
+
+    def wait_for_ssh_access
+      Timer.timeout("#{@host}: SSH test",self.class::SSH_READY_TIMEOUT) do
+        until sshable? do
+          Tunneler.log "Waiting between connection attempts", :debug
+          sleep 5
+        end
+      end
+    end
+
+    def sshable?
+      begin
+        return test_connectivity
+      rescue Exception => e
+        if ACCEPTABLE_CONNECTIVITY_ERRORS.include?(e.class)
+          Tunneler.log "Connectivity error: #{e.class} - #{e.message}", :debug
+          return false
+        else
+          raise e
+        end
+      end
+    end
+
+    def test_connectivity
+      options_override = @options.clone
+      options_override[:timeout] = self.class::SSH_CONNECTIVITY_TIMEOUT
+      options_override[:verbose] = :debug if Tunneler.debug
+      if ssh("whoami", options_override).strip == @user
+        return true
+      end
+    end
+
+    def ssh(command, options_override={})
+      if options_override.empty?
+        options = @options
+      else
+        options = options_override
+      end
+      output = ""
+      Net::SSH.start(@host, @user, @options) do |ssh|
+        output = ssh.exec!(command)
+      end
+      output
+    end
+
+    def scp(local_path, remote_path)
+      Net::SSH.start(@host, @user, @options) do |ssh|
+        ssh.scp.upload!(local_path, remote_path, SCP_OPTIONS)
+      end
+    end
+
+  end
+end

data/lib/tunneler/ssh_tunnel.rb

@@ -0,0 +1,103 @@
+module Tunneler
+  class SshTunnel
+
+    attr_reader :options
+
+    def initialize(user, host, options={})
+      @user = user
+      @host = host
+      @options = Ssh.merge_options(options)
+      
+      connect
+    end
+
+    def connect
+      @gateway = Gateway.connect(@host, @user, @options)
+    end
+
+    def remote(user, host, options={})
+      Remote.new(@gateway, user, host, Ssh.merge_options(options))
+    end
+
+    def terminate
+      @gateway.shutdown!
+    end
+
+    class Gateway < Net::SSH::Gateway
+
+      def initialize(host, user, options={})
+        super
+        @host = host
+        @user = user
+        @options = options
+      end
+
+      def self.connect(host, user, options={})
+        gateway = self.new(host, user, options)
+        gateway.open("127.0.0.1", self.random_open_port)
+        gateway
+      end
+
+      def self.random_open_port
+        socket = Socket.new(:INET, :STREAM, 0)
+        socket.bind(Addrinfo.tcp("127.0.0.1", 0))
+        socket.local_address.ip_port
+      end
+
+      def reconnect
+        shutdown!
+        self.class.connect(@host,@user,@options)
+      end
+
+    end
+
+    class Remote < Ssh
+
+      SSH_READY_TIMEOUT = 100
+      ACCEPTABLE_CONNECTIVITY_ERRORS = [Net::SSH::Disconnect, IOError]
+
+      def initialize(gateway, user, host, options={})
+        @gateway = gateway
+        super(user, host, options)
+      end
+
+      def sshable?
+        begin
+          gateway_reconnect
+          return test_connectivity
+        rescue Exception => e
+          if ACCEPTABLE_CONNECTIVITY_ERRORS.include?(e.class)
+            Tunneler.log "Connectivity error: #{e.class} - #{e.message}", :debug
+            return false
+          else
+            raise e
+          end
+        end
+      end
+
+      def gateway_reconnect
+        @gateway = @gateway.reconnect
+      end
+
+      def ssh(command, options_override={})
+        if options_override.empty?
+          options = @options
+        else
+          options = options_override
+        end
+        output = ""
+        @gateway.ssh(@host, @user, @options) do |ssh|
+          output = ssh.exec!(command)
+        end
+        output
+      end
+
+      def scp(local_path, remote_path)
+        @gateway.ssh(@host, @user, @options) do |ssh|
+          ssh.scp.upload!(local_path, remote_path, SCP_OPTIONS)
+        end
+      end
+    end
+
+  end
+end

data/lib/tunneler/version.rb

@@ -0,0 +1,3 @@
+module Tunneler
+  VERSION = "0.0.1"
+end

data/tunneler.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tunneler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tunneler"
+  spec.version       = Tunneler::VERSION
+  spec.authors       = ["Nels Broberg"]
+  spec.email         = ["zifridorio@hotmail.com"]
+  spec.description   = %q{Command line tool and ruby gem for SSH tunneling}
+  spec.summary       = %q{SSH to server via tunneler host}
+  spec.homepage      = "https://github.com/nbroberg/tunneler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "net-scp"
+  spec.add_dependency "net-ssh-gateway"
+  spec.add_dependency "trollop"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "debugger"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: tunneler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nels Broberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh-gateway
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command line tool and ruby gem for SSH tunneling
+email:
+- zifridorio@hotmail.com
+executables:
+- tunneler
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/tunneler
+- lib/tunneler.rb
+- lib/tunneler/cli.rb
+- lib/tunneler/config.rb
+- lib/tunneler/logger.rb
+- lib/tunneler/ssh.rb
+- lib/tunneler/ssh_tunnel.rb
+- lib/tunneler/version.rb
+- tunneler.gemspec
+homepage: https://github.com/nbroberg/tunneler
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: SSH to server via tunneler host
+test_files: []