tbm 0.1.0

data/README.md

@@ -0,0 +1,5 @@
+# Tunnels
+
+A simple Ruby script to manage named SSH tunnels because I need these regularly and it's a bit of a pain to manage this in some other way.
+
+At the moment, this will be a command that you invoke, and leave running. At some point, it might make sense to make this two processes -- one that stays alive while there are active tunnels, and a command-line that interacts with that process. For now, that's more work than I intend to bite off -- more of a v2 feature.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake/clean'
+require 'rake/packagetask'
+require 'rspec/core/rake_task'
+require 'rspec'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'tbm'
+
+CLEAN.include( 'coverage', 'pkg' )
+
+desc '"spec" (run RSpec)'
+task :default => :spec
+
+desc "Run RSpec on spec/*"
+RSpec::Core::RakeTask.new
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec,/gems/,/rubygems/', '--text-report']
+end
+
+spec = Gem::Specification.new do |spec|
+  spec.name = 'tbm'
+  spec.version = Tunnel::VERSION
+  spec.date = Tunnel::DATE
+  spec.summary = 'Named SSH tunnels, like bookmarks.'
+  spec.description = 'The "Tunnel Boring Machine" is meant to bore ssh tunnels through the internet to your desired destination simply and repeatedly, as often as you need them. This is a tool for someone who needs SSH tunnels frequently.'
+  spec.author = 'Geoffrey Wiseman'
+  spec.email = 'geoffrey.wiseman@codiform.com'
+  spec.homepage = 'http://github.com/geoffreywiseman/tunnel-boring-machine'
+  spec.executables << 'tbm'
+  
+  spec.files = Dir['{lib,spec}/**/*.rb', 'bin/*', 'Rakefile', 'README.md', 'UNLICENSE']
+  
+  spec.add_dependency( 'net/ssh', '>= 2.6.2' )
+end
+
+Gem::PackageTask.new( spec ) do |pkg|
+  pkg.need_tar_gz = true
+  pkg.need_zip = true
+end

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/bin/tbm

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'tbm'
+
+Tunnel::CommandLineInterface.parse_and_run

data/lib/tbm.rb

@@ -0,0 +1,4 @@
+require 'tunnel/meta'
+require 'tunnel/cli'
+require 'tunnel/config'
+require 'tunnel/target'

data/lib/tunnel/cli.rb

@@ -0,0 +1,69 @@
+require 'net/ssh'
+
+module Tunnel
+	class CommandLineInterface
+		def initialize( config )
+			@config = config
+			@target = nil
+			@cancelled = false
+		end
+
+		def parse
+			if ARGV.size != 1 
+				print_targets "SYNTAX: tbm <target>\n\nWhere target is one of:" 
+			else
+				target_name = ARGV[0]
+				@target = @config.get_target( target_name )
+				print_targets( "Cannot find target: #{target_name}\n\nThese are the targets currently defined:" ) if @target.nil?
+			end
+		end
+
+		def print_targets( message )
+			puts message
+			@config.each_target { |target| puts "\t#{target.name}" }
+		end
+
+
+		def valid?
+			!@target.nil?
+		end
+
+		def bore
+			puts "Starting #{APP_NAME} v#{VERSION}"
+			puts
+
+			trap("INT") { @cancelled = true }
+			Net::SSH.start( @target.host, @target.username ) do |session|
+				forward_ports( session )
+			end
+
+			puts "Shutting down the machine."
+		end
+
+		def forward_ports( session )
+			begin
+				puts "Opened connection to #{@target.username}@#{@target.host}:"
+				@target.each_forward do |fwd|
+					remote_server, port = fwd
+					session.forward.local( port, remote_server, port )
+					puts "\tforwarded port #{port} to #{remote_server}:#{port}"
+				end
+				puts "\twaiting for Ctrl-C..."
+				session.loop(0.1) { not @cancelled }
+				puts "\n\tCtrl-C pressed. Exiting."
+			rescue Errno::EACCES
+				@cancelled = true
+				puts "\tCould not open all ports; you may need to sudo if port < 1000."
+			end
+		end
+
+		def self.parse_and_run
+			config = Config.new
+			if config.valid? 
+				cli = CommandLineInterface.new( config )
+				cli.parse
+				cli.bore if cli.valid?
+			end
+		end
+	end
+end

data/lib/tunnel/config.rb

@@ -0,0 +1,93 @@
+require 'etc'
+
+module Tunnel
+	class Config
+		CONFIG_FILE = File.expand_path( '~/.tunnels' )
+
+		def initialize
+			@valid = nil
+			@targets = []
+			if File.file? CONFIG_FILE
+				config_data = YAML.load_file( CONFIG_FILE )
+				parse config_data if config_data.is_a? Hash
+			else
+				puts "Configure your tunnels in ~/.tunnels in YAML form."
+			end
+		end
+
+		def valid?
+			@valid
+		end
+
+		def get_target( name )
+			@targets.find { |target| target.has_name?(name) }
+		end
+
+		def each_target( &block )
+			@targets.each { |target| yield target }
+		end
+
+		private
+
+		def parse( targets )
+			targets.each_key { |name| parse_target name, targets[name] }
+			@valid = true if @valid.nil? && !@targets.empty?
+		end
+
+		def parse_target( name, config )
+			if config.is_a? Hash
+				target = create_target( name, config )
+				unless target.nil? 
+					@targets << target
+					parse_forward( target, config['forward'] )
+				end
+			else
+				puts "Cannot parse target '#{name}' (#{config.class})"
+				@valid = false
+			end
+		end
+
+		def create_target( name, config )
+			if config.has_key? 'host' then
+				if config.has_key? 'username' then
+					username = config['username']
+				else
+					username = Etc.getlogin
+				end
+				Target.new name, config['host'], username
+			else
+				puts "Cannot parse target '#{name}': no host found."
+				@valid = false
+			end
+		end
+
+		def parse_forward( target, config )
+			case config
+			when nil
+				puts "Target #{target.name} has no forwards defined."
+				@valid = false
+			when Fixnum
+				target.forward_port( config )
+			when Array
+				config.each { |port| target.forward_port(port) }
+			when Hash
+				config.each_key do |server|
+					server_config = config[ server ]
+					case server_config
+					when Fixnum
+						target.forward_port( server_config, server )
+					when Array
+						server_config.each { |port| target.forward_port( port, server ) }
+					else
+ 						puts "Not sure how to handle forward from #{target.host} to #{server}: #{server_config.class}"
+ 					end
+				end
+			else
+				puts "Not sure how to handle forward for '#{target.host}': #{config.class}"
+				@valid = false
+			end
+		end
+
+	end
+
+end

data/lib/tunnel/meta.rb

@@ -0,0 +1,5 @@
+module Tunnel
+	APP_NAME = "Tunnel Boring Machine"
+	VERSION = "0.1.0"
+	DATE = '2012-11-23'
+end

data/lib/tunnel/target.rb

@@ -0,0 +1,24 @@
+module Tunnel
+	class Target
+		attr_reader :name, :host, :username
+
+		def initialize( name, host, username )
+			@name = name
+			@host = host
+			@username = username
+			@forwards = []
+		end
+
+		def forward_port( port, server='localhost' ) 
+			@forwards << [ server, port ]
+		end
+
+		def has_name?( name )
+			@name==name
+		end
+
+		def each_forward( &block )
+			@forwards.each { |fwd| yield fwd }
+		end
+	end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: tbm
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Geoffrey Wiseman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
+  name: net/ssh
+  requirement: *id001
+  prerelease: false
+description: The "Tunnel Boring Machine" is meant to bore ssh tunnels through the internet to your desired destination simply and repeatedly, as often as you need them. This is a tool for someone who needs SSH tunnels frequently.
+email: geoffrey.wiseman@codiform.com
+executables: 
+- tbm
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/tbm.rb
+- lib/tunnel/cli.rb
+- lib/tunnel/config.rb
+- lib/tunnel/meta.rb
+- lib/tunnel/target.rb
+- bin/tbm
+- Rakefile
+- README.md
+- UNLICENSE
+has_rdoc: true
+homepage: http://github.com/geoffreywiseman/tunnel-boring-machine
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Named SSH tunnels, like bookmarks.
+test_files: []
+