mojombo-proxymachine 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tom Preston-Werner
+
+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,101 @@
+ProxyMachine
+============
+
+By Tom Preston-Werner (tom@mojombo.com)
+
+WARNING: This software is alpha and should not be used in production without
+extensive testing. You should not consider this project production ready until
+it is released as 1.0.
+
+
+Description
+-----------
+
+ProxyMachine is a simple content aware (layer 7) TCP routing proxy built on
+EventMachine that lets you configure the routing logic in Ruby.
+
+If you need to proxy connections to different backend servers depending on the
+contents of the transmission, then ProxyMachine will make your life easy!
+
+The idea here is simple. For each client connection, start receiving data
+chunks and placing them into a buffer. Each time a new chunk arrives, send the
+buffer to a user specified block. The block's job is to parse the buffer to
+determine where the connection should proxied. If the buffer contains enough
+data to make a determination, the block returns the address and port of the
+correct backend server. If not, it can choose to either do nothing and wait
+for more data to arrive, or close the connection. Once the block returns an
+address, a connection to the backend is made, the buffer is replayed to the
+backend, and the client and backend connections are hooked up to form a
+straight proxy. This bidirectional proxy continues to exist until with the
+client or backend close the connection.
+
+
+Installation
+------------
+
+    gem install mojombo-proxymachine -s http://gems.github.com
+
+
+Running
+-------
+
+    Usage:
+      proxymachine -c <config file> [-h <host>] [-p <port>]
+
+    Options:
+      -c, --config CONFIG              Configuration file
+      -h, --host HOST                  Hostname to bind. Default 0.0.0.0
+      -p, --port PORT                  Port to listen on. Default 5432
+
+
+Example routing config file
+---------------------------
+
+    class GitRouter
+      # Look at the routing table and return the correct address for +name+
+      # Returns "<host>:<port>" e.g. "ae8f31c.example.com:9418"
+      def self.lookup(name)
+        ...
+      end
+    end
+
+    # Perform content-aware routing based on the stream data. Here, the
+    # header information from the Git protocol is parsed to find the 
+    # username and a lookup routine is run on the name to find the correct
+    # backend server. If no match can be made yet, do nothing with the
+    # connection yet.
+    proxy do |data|
+      if data =~ %r{^....git-upload-pack /([\w\.\-]+)/[\w\.\-]+\000host=\w+\000}
+        name = $1
+        GitRouter.lookup(name)
+      else
+        :noop
+      end
+    end
+
+
+Contribute
+----------
+
+If you'd like to hack on ProxyMachine, start by forking my repo on GitHub:
+
+http://github.com/mojombo/proxymachine
+
+To get all of the dependencies, install the gem first. The best way to get
+your changes merged back into core is as follows:
+
+1. Clone down your fork
+1. Create a topic branch to contain your change
+1. Hack away
+1. Add tests and make sure everything still passes by running `rake`
+1. If you are adding new functionality, document it in the README.md
+1. Do not change the version number, I will do that on my end
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send me (mojombo) a pull request for your branch
+
+
+Copyright
+---------
+
+Copyright (c) 2009 Tom Preston-Werner. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "proxymachine"
+    gem.summary = %Q{TODO}
+    gem.email = "tom@mojombo.com"
+    gem.homepage = "http://github.com/mojombo/proxymachine"
+    gem.authors = ["Tom Preston-Werner"]
+    gem.add_dependency('eventmachine', '>= 0.12.6')
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "proxymachine #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/bin/proxymachine

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'optparse'
+require 'proxymachine'
+
+begin
+  options = {:host => "0.0.0.0", :port => 5432}
+
+  opts = OptionParser.new do |opts|
+    opts.banner = <<-EOF
+  Usage:
+    proxymachine -c <config file> [-h <host>] [-p <port>]
+
+  Options:
+EOF
+
+    opts.on("-cCONFIG", "--config CONFIG", "Configuration file") do |x|
+      options[:config] = x
+    end
+
+    opts.on("-hHOST", "--host HOST", "Hostname to bind. Default 0.0.0.0") do |x|
+      options[:host] = x
+    end
+
+    opts.on("-pPORT", "--port PORT", "Port to listen on. Default 5432") do |x|
+      options[:host] = x
+    end
+  end
+
+  opts.parse!
+
+  load(options[:config])
+  ProxyMachine.run(options[:host], options[:port])
+rescue Exception => e
+  if e.instance_of?(SystemExit)
+    raise
+  else
+    puts 'Uncaught exception'
+    puts e.message
+    puts e.backtrace.join("\n")
+  end
+end

data/examples/git.rb

@@ -0,0 +1,26 @@
+# This is a config file for ProxyMachine. It pulls the username out of
+# the Git stream and can proxy to different locations based on that value
+# Run with `proxymachine -c examples/git.rb`
+
+class GitRouter
+  # Look at the routing table and return the correct address for +name+
+  # Returns "<host>:<port>" e.g. "ae8f31c.example.com:9418"
+  def self.lookup(name)
+    puts "Proxying for user #{name}"
+    "localhost:9418"
+  end
+end
+
+# Perform content-aware routing based on the stream data. Here, the
+# header information from the Git protocol is parsed to find the
+# username and a lookup routine is run on the name to find the correct
+# backend server. If no match can be made yet, do nothing with the
+# connection yet.
+proxy do |data|
+  if data =~ %r{^....git-upload-pack /([\w\.\-]+)/[\w\.\-]+\000host=(.+)\000}
+    name, host = $1, $2
+    GitRouter.lookup(name)
+  else
+    :noop
+  end
+end

data/examples/transparent.rb

@@ -0,0 +1,4 @@
+proxy do |data|
+  p data
+  "localhost:80"
+end

data/lib/proxymachine.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'eventmachine'
+
+require 'proxymachine/client_connection'
+require 'proxymachine/server_connection'
+
+class ProxyMachine
+  def self.log(str)
+    puts str if false
+  end
+
+  def self.incr
+    @@counter ||= 0
+    @@counter += 1
+    log @@counter
+  end
+
+  def self.decr
+    @@counter ||= 0
+    @@counter -= 1
+    log @@counter
+  end
+
+  def self.set_router(block)
+    @@router = block
+  end
+
+  def self.router
+    @@router
+  end
+
+  def self.run(host, port)
+    EM.kqueue
+    EM.epoll
+
+    EM.run do
+      EventMachine::Protocols::ClientConnection.start(host, port)
+    end
+  end
+end
+
+module Kernel
+  def proxy(&block)
+    ProxyMachine.set_router(block)
+  end
+end

data/lib/proxymachine/client_connection.rb

@@ -0,0 +1,81 @@
+module EventMachine
+  module Protocols
+    class ClientConnection < Connection
+      def self.start(host, port)
+        EM.start_server(host, port, self)
+        puts "Listening on #{host}:#{port}"
+      end
+
+      def post_init
+        @buffer = []
+        @tries = 0
+        ProxyMachine.incr
+      end
+
+      def receive_data(data)
+        if !@server_side
+          @buffer << data
+          ensure_server_side_connection
+        else @server_side
+          # p data
+          @server_side.send_data(data)
+        end
+      rescue => e
+        close_connection
+        puts "#{e.class} - #{e.message}"
+      end
+
+      def ensure_server_side_connection
+        @timer.cancel if @timer
+        unless @server_side
+          op = ProxyMachine.router.call(@buffer.join)
+          if op.instance_of?(String)
+            m, host, port = *op.match(/^(.+):(.+)$/)
+            if try_server_connect(host, port.to_i)
+              send_and_clear_buffer
+            end
+          elsif op == :noop
+            # do nothing
+          else
+            close_connection
+          end
+        end
+      end
+
+      def try_server_connect(host, port)
+        @server_side = ServerConnection.request(host, port, self)
+        if @tries > 0
+          puts "Successful connection."
+        end
+        true
+      rescue => e
+        if @tries < 10
+          @tries += 1
+          puts "Failed on server connect attempt #{@tries}. Trying again..."
+          @timer.cancel if @timer
+          @timer = EventMachine::Timer.new(0.1) do
+            self.ensure_server_side_connection
+          end
+        else
+          puts "Failed after ten connection attempts."
+        end
+        false
+      end
+
+      def send_and_clear_buffer
+        if !@buffer.empty?
+          @buffer.each do |x|
+            # p x
+            @server_side.send_data(x)
+          end
+          @buffer = []
+        end
+      end
+
+      def unbind
+        @server_side.close_connection_after_writing if @server_side
+        ProxyMachine.decr
+      end
+    end
+  end
+end

data/lib/proxymachine/server_connection.rb

@@ -0,0 +1,22 @@
+module EventMachine
+  module Protocols
+    class ServerConnection < Connection
+      def self.request(host, port, client_side)
+        EventMachine.connect(host, port, self, client_side)
+      end
+
+      def initialize(conn)
+        @client_side = conn
+      end
+
+      def receive_data(data)
+        # p data
+        @client_side.send_data(data)
+      end
+
+      def unbind
+        @client_side.close_connection_after_writing
+      end
+    end
+  end
+end

data/test/proxymachine_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ProxymachineTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'proxymachine'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: mojombo-proxymachine
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom Preston-Werner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-27 00:00:00 -07:00
+default_executable: proxymachine
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.6
+    version: 
+description: 
+email: tom@mojombo.com
+executables: 
+- proxymachine
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- VERSION.yml
+- bin/proxymachine
+- examples/git.rb
+- examples/transparent.rb
+- lib/proxymachine.rb
+- lib/proxymachine/client_connection.rb
+- lib/proxymachine/server_connection.rb
+- test/proxymachine_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mojombo/proxymachine
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/proxymachine_test.rb
+- test/test_helper.rb
+- examples/git.rb
+- examples/transparent.rb