forwardmachine 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in forwardmachine.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mariusz Pietrzyk
+
+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,39 @@
+# ForwardMachine
+
+Port forwarding service configurable in runtime.
+
+# How does it work?
+
+ForwardMachine listens on TCP port for forward requests.
+These requests are simple, they consist of host:port, e.g. host.example.com:3000
+As response, host and port where forwarding has been set up is returned.
+
+## Installation
+
+    $ gem install forwardmachine
+
+## Usage
+
+1. Start forwarder for host proxy.example.com
+
+    $ forwardmachine --forwarder-host proxy.example.com --ports-range 8000..9000
+
+2. Control server by default will listen on localhost:8899.
+Connect to it and create a new forwarder (here we use nc tool).
+Below we have created two ports forwards.
+
+    $ nc localhost 8899
+    internal1.example.com:7777
+    proxy.example.com:8000
+
+    $ nc localhost 8899
+    internal2.example.com:9999
+    proxy.example.com:8001
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/forwardmachine

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require 'forwardmachine'
+require 'optparse'
+
+options = {
+  log: 'forwardmachine.log'
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: forwardmachine [options]"
+
+  opts.on("-f", "--forwarder-host [HOST]", String, "Forwarder host (default: localhost)") do |v|
+    options[:forwarder_host] = v
+  end
+
+  opts.on("-r", "--ports-range [RANGE]", String, "Forwarder ports range (default: 23200..23500)") do |v|
+    options[:ports_range] = Range.new(*v.split("..").map(&:to_i))
+  end
+
+  opts.on("-b", "--bind [HOST]", String, "Controller host (default: localhost) ") do |v|
+    options[:host] = v
+  end
+
+  opts.on("-p", "--port [PORT]", Integer, "Controller port (default: 8899)") do |v|
+    options[:port] = v
+  end
+
+  opts.on("-l", "--log [PATH]", String, "Log file (default: forwardmachine.log)") do |v|
+    options[:log] = v
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+ForwardMachine.logger_path = options[:log]
+
+controller = ForwardMachine::Controller.new(options)
+controller.run

data/forwardmachine.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/forwardmachine/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mariusz Pietrzyk"]
+  gem.email         = ["wijet@wijet.pl"]
+  gem.description   = %q{
+    Simple forwarding service written in Ruby with EventMachine.
+    Allows to set up port forwarding to given destination in runtime.
+  }
+  gem.summary       = %q{Port forwarding service configurable in runtime}
+  gem.homepage      = "https://github.com/ragnarson/forwardmachine"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "forwardmachine"
+  gem.require_paths = ["lib"]
+  gem.version       = ForwardMachine::VERSION
+  
+  gem.add_runtime_dependency "eventmachine"
+  gem.add_runtime_dependency "em-logger"
+  
+  gem.add_development_dependency "rspec"
+end

data/lib/forwardmachine.rb

@@ -0,0 +1,23 @@
+require "eventmachine"
+require "logger"
+require "em-logger"
+require "forwardmachine/version"
+require "forwardmachine/ports_pool"
+require "forwardmachine/controller"
+require "forwardmachine/controller_connection"
+require "forwardmachine/forwarder"
+require "forwardmachine/forwarder_connection"
+require "forwardmachine/forwarded_connection"
+
+module ForwardMachine
+  class << self
+    attr_accessor :logger_path
+  end
+end
+
+def logger
+  @logger ||= begin
+    logger = Logger.new(ForwardMachine.logger_path)
+    EM::Logger.new(logger)
+  end
+end

data/lib/forwardmachine/controller.rb

@@ -0,0 +1,22 @@
+module ForwardMachine
+  # Server which listens for forward requests.
+  # It should be run on internal address, like localhost
+  # because it doesn't have any authentication.
+  # Each connection is handled by ControllerConnection
+  class Controller
+    def initialize(options = {})
+      @host = options[:host] || "localhost"
+      @port = options[:port] || 8899
+      @forwarder_host = options[:forwarder_host] || @host
+      @ports = PortsPool.new(options[:ports_range] || (23200..23500))
+    end
+
+    def run
+      EM.run {
+        EM.start_server(@host, @port, ControllerConnection,
+          @forwarder_host, @ports)
+        logger.info("Started controller at #{@host}:#{@port}")
+      }
+    end
+  end
+end

data/lib/forwardmachine/controller_connection.rb

@@ -0,0 +1,26 @@
+module ForwardMachine
+  # Connection to controller server
+  # Sets up new forwarder to destination host given by client
+  class ControllerConnection < EM::Connection
+    attr_reader :host, :ports
+
+    # Internal: Initialize new ForwardConnection
+    # host - Host on which forwarders (servers) will be created
+    # ports - Ports pool from which ports for forwarders
+    #         will be taken
+    def initialize(host, ports)
+      @host = host
+      @ports = ports
+    end
+
+    # Internal: Receives destination in format "host:port"
+    # from client, creates new forwarder, returns forwarder
+    # socket address in format "host:port" back to the client
+    # and closes the connection.
+    def receive_data(data)
+      forwarder = Forwarder.new(host, data.strip, ports)
+      send_data(forwarder.start)
+      close_connection_after_writing
+    end
+  end
+end

data/lib/forwardmachine/forwarded_connection.rb

@@ -0,0 +1,16 @@
+module ForwardMachine
+  # Connection between forwarder machine
+  # and a service on destination host
+  class ForwardedConnection < EM::Connection
+    def initialize(forwarder_connection)
+      @forwarder_connection = forwarder_connection
+    end
+
+    # Internal: Sets both ways proxy between forwarder server
+    # and client (on destination host)
+    def post_init
+      EM.enable_proxy(self, @forwarder_connection)
+      EM.enable_proxy(@forwarder_connection, self)
+    end
+  end
+end

data/lib/forwardmachine/forwarder.rb

@@ -0,0 +1,63 @@
+module ForwardMachine
+  # Server which accepts traffic on available port taken from
+  # ports pool. Each connection is handled by ForwarderConnection object
+  class Forwarder
+    # How long server will be open, waiting for the first connetion.
+    FIRST_USE_TIMEOUT = 15
+
+    attr_reader :host, :destination, :ports_pool, :port, :connections
+
+    # Public: Initialize new Forwarder server
+    #
+    # host        - Host as String on which server will listen
+    # destination - Destination socket as String where traffic will
+    #               be forwarded (in format host:port)
+    # ports       - PortsPool object with ports numbers from which port
+    #               for forwarder will be taken
+    def initialize(host, destination, ports_pool)
+      @host = host
+      @ports_pool = ports_pool
+      @port = ports_pool.reserve
+      @destination = destination
+      @connections = 0
+    end
+
+    # Public: Start forwarding server on given host and port taken from PortsPool.
+    # Returns: Socket address of the server in format "host:port" as String
+    def start
+      @server = EM.start_server(host, port, ForwarderConnection, destination, self) {
+        @connections += 1
+        @inactivity_timer.cancel
+      }
+      @inactivity_timer = EM::PeriodicTimer.new(FIRST_USE_TIMEOUT) { stop }
+      logger.info("Started forwarder #{socket_address} to #{destination}")
+      socket_address
+    end
+
+    # Internal: Callback which is called from connection to Forwarder when
+    # client disconnects. Stops Forwarder server if it's not used by any
+    # connection.
+    def forwarder_connection_closed
+      stop if (@connections -= 1).zero?
+    end
+
+    # Public: Fowarder socket address
+    # Returns: String with host and port on which forwarder listens
+    def socket_address
+      "#{host}:#{port}"
+    end
+
+    def to_s
+      socket_address
+    end
+
+    private
+
+    def stop
+      logger.info("Stopped forwarder #{socket_address} to #{destination}")
+      @inactivity_timer.cancel
+      EM.stop_server(@server)
+      ports_pool.release(port)
+    end
+  end
+end

data/lib/forwardmachine/forwarder_connection.rb

@@ -0,0 +1,50 @@
+require 'socket'
+
+module ForwardMachine
+  # Connection between client and forwarder server.
+  class ForwarderConnection < EM::Connection
+    def initialize(destination, forwarder)
+      @destination = destination
+      @destination_host, @destination_port = destination.split(":")
+      @forwarder = forwarder
+      # Number of seconds server will wait for TCP connection in pending state
+      self.pending_connect_timeout = 60
+      # Number of seconds server connection remain open waiting for data
+      self.comm_inactivity_timeout = 60 * 30
+    end
+
+    # Internal: After client is connected to forwarder, open connection
+    # to destination host and port
+    def post_init
+      logger.info("Client #{peer} connected to forwarder #{@forwarder} to #{@destination}")
+      EM.connect(@destination_host, @destination_port,
+        ForwardedConnection, self)
+    rescue RuntimeError => e
+      logger.error("Client #{peer} on #{@forwarder} couldn't be connected with #{@destination}")
+      close_connection
+    end
+
+    # Internal: After forwarder destination disconnected
+    # terminate forwarder connection
+    def proxy_target_unbound
+      logger.info("Destination #{@destination} disconnected from forwarder #{@forwarder}")
+      close_connection
+    end
+
+    # Internal: After client disconnects from forwarder
+    # notify forwarder server about it.
+    def unbind
+      logger.info("Client #{peer} disconnected from forwarder #{@forwarder} to #{@destination}")
+      @forwarder.forwarder_connection_closed
+    end
+
+    private
+
+    def peer
+      @peer ||= begin
+                  port, ip = Socket.unpack_sockaddr_in(get_peername)
+                  "#{ip}:#{port}"
+                end
+    end
+  end
+end

data/lib/forwardmachine/ports_pool.rb

@@ -0,0 +1,26 @@
+require 'set'
+
+module ForwardMachine
+  # PortsPool from which ports will be taken for creating
+  # port forwards.
+  class PortsPool < SortedSet
+    # Public: Initialize pool with range of ports
+    def initialize(range)
+      super(range.to_a)
+    end
+
+    # Public: Reserve one port
+    # Returns: Port number as Integer
+    #          nil if no port is available
+    def reserve
+      delete(elem = first)
+      elem
+    end
+
+    # Public: Release given port, puts it back in the pool
+    # makes it available for later reservation
+    def release(port)
+      self << port
+    end
+  end
+end

data/lib/forwardmachine/version.rb

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

data/spec/forwardmachine/forwarder_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe ForwardMachine::Forwarder do
+  around do |example|
+    EM.run do
+      ports_pool = ForwardMachine::PortsPool.new(23000..23010)
+      @forwarder = ForwardMachine::Forwarder.new('localhost',
+        'localhost:30000', ports_pool)
+      example.run
+    end
+  end
+
+  describe "#start" do
+    before do
+      EM.start_server('localhost', 30000, FakeServer)
+      EM.run do
+        @forward = @forwarder.start
+        @host, @port = @forward.split(':')
+      end
+    end
+
+    it "should create new forwarder server and return port" do
+      EM.connect(@host, @port, FakeClient, 'hey') do |socket|
+        socket.onmessage do |message|
+          socket.send_data('close')
+          socket.onmessage { |m| m.should == '> closed' }
+          socket.onclose { EM.stop }
+        end
+      end
+    end
+
+    it "should count connections" do
+      EM.connect(@host, @port, FakeClient, 'hey') do |socket|
+        socket.onmessage do |message|
+          @forwarder.connections.should == 1
+          socket.send_data('close')
+          socket.onmessage { EM.stop }
+        end
+      end
+    end
+  end
+
+  context "forwarder server not used for FIRST_USE_TIMEOUT seconds" do
+    it "should close forwarder" do
+      ForwardMachine::Forwarder.send :remove_const, :FIRST_USE_TIMEOUT
+      ForwardMachine::Forwarder::FIRST_USE_TIMEOUT = 0.05
+      EM.start_server('localhost', 30000, FakeServer)
+      host, port = nil, nil
+      EM.run do
+        host, port = @forwarder.start.split(':')
+      end
+      EM.add_timer(0.1) do
+        socket = EM.connect(host, port, FakeClient, 'hey')
+        socket.onerror { socket.should be_error; EM.stop }
+        socket.onmessage { raise }
+      end
+    end
+  end
+end

data/spec/forwardmachine/ports_pool_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe ForwardMachine::PortsPool do
+  let(:pool) { ForwardMachine::PortsPool.new(100..105) }
+
+  describe "#reserve" do
+    it "should reserve port from a pool" do
+      pool.reserve.should == 100
+      pool.reserve.should == 101
+    end
+  end
+
+  describe "#release" do
+    it "should return given port back to the pool" do
+      pool.reserve
+      pool.reserve
+      pool.release(100)
+      pool.reserve.should == 100
+    end
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe ForwardMachine do
+  around do |example|
+    EM.run { forwardmachine; example.run }
+  end
+
+  it "should listen on control port and return forwarder port number" do
+    socket = EM.connect('localhost', 27000, FakeClient, 'localhost:30000')
+    socket.onmessage { |m| m.should == 'localhost:23200' }
+    socket.onclose { EM.stop }
+  end
+
+  it "should forward connection to destination host and port" do
+    EM.start_server('localhost', 30000, FakeServer)
+    control_socket = EM.connect('localhost', 27000, FakeClient, 'localhost:30000')
+    control_socket.onmessage do |forward|
+      host, port = forward.split(':')
+      socket = EM.connect(host, port, FakeClient, 'hey')
+      socket.onmessage { |m| m.should == '> hey' }
+      EM.add_timer(0.1) do
+        socket.send_data('close')
+        socket.onmessage { |m| m.should == '> closed'; EM.stop }
+      end
+    end
+  end
+
+  it "should close forwarded when destination host disconnected" do
+    EM.start_server('localhost', 30000, FakeServer)
+    control_socket = EM.connect('localhost', 27000, FakeClient, 'localhost:30000')
+    control_socket.onmessage do |forward|
+      host, port = forward.split(':')
+      EM.connect(host, port, FakeClient, 'close') do |c|
+        c.onmessage { |m| m.should == '> closed' }
+        c.should_not be_error
+        c.onclose do
+          EM.connect('localhost', port, FakeClient) do |c|
+            c.should be_error
+            EM.stop
+          end
+        end
+      end
+    end
+  end
+
+  it "should not close forwarder when any connection is ongoing" do
+    EM.start_server('localhost', 30000, FakeServer)
+    control_socket = EM.connect('localhost', 27000, FakeClient, 'localhost:30000')
+    control_socket.onmessage do |forward|
+      host, port = forward.split(':')
+      EM.connect(host, port, FakeClient, 'first') do |first|
+        first.onmessage { |m| m.should == '> first' }
+        second = EM.connect(host, port, FakeClient, 'second') do |second|
+                   second.onmessage { |m| m.should == '> second' }
+                 end
+
+        EM.add_timer(0.1) { first.close_connection }
+        EM.add_timer(0.2) do
+          # second still operational, after first one is closed
+          second.send_data('close')
+          second.onmessage { |m| m.should == '> closed' }
+          second.onclose { EM.stop }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+require 'forwardmachine'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+
+def forwardmachine
+  controller = ForwardMachine::Controller.new(
+    host: "localhost", port: 27000)
+  controller.run
+end
+
+class FakeServer < EM::Connection
+  def receive_data(data)
+    if data == 'close'
+      send_data('> closed')
+      close_connection_after_writing
+    else
+      send_data("> #{data}")
+    end
+  end
+end
+
+class FakeClient < EM::Connection
+  def onclose(&block); @onclose = block; end
+  def onmessage(&block); @onmessage = block; end
+  def onerror(&block); @onerror = block; end
+
+  def initialize(message = nil)
+    @message = message
+  end
+
+  def post_init
+    send_data(@message) if @message
+  end
+
+  def receive_data(data)
+    @onmessage.call(data) if @onmessage
+  end
+
+  def unbind
+    @onerror.call if error? and @onerror
+    @onclose.call if @onclose
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: forwardmachine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mariusz Pietrzyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  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: em-logger
+  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: 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'
+description: ! "\n    Simple forwarding service written in Ruby with EventMachine.\n
+  \   Allows to set up port forwarding to given destination in runtime.\n  "
+email:
+- wijet@wijet.pl
+executables:
+- forwardmachine
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/forwardmachine
+- forwardmachine.gemspec
+- lib/forwardmachine.rb
+- lib/forwardmachine/controller.rb
+- lib/forwardmachine/controller_connection.rb
+- lib/forwardmachine/forwarded_connection.rb
+- lib/forwardmachine/forwarder.rb
+- lib/forwardmachine/forwarder_connection.rb
+- lib/forwardmachine/ports_pool.rb
+- lib/forwardmachine/version.rb
+- spec/forwardmachine/forwarder_spec.rb
+- spec/forwardmachine/ports_pool_spec.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ragnarson/forwardmachine
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Port forwarding service configurable in runtime
+test_files:
+- spec/forwardmachine/forwarder_spec.rb
+- spec/forwardmachine/ports_pool_spec.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb