em-socksify 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# EM-Socksify: Transparent SOCKS support for any EventMachine protocol
+
+Dealing with SOCKS proxies is pain. EM-Socksify provides a simple shim to setup & negotiate a SOCKS5 connection for any EventMachine protocol. To add SOCKS support, all you have to do is include the module and provide your destination address.
+
+## Example: Routing HTTP request via SOCKS5 proxy
+
+    class Handler < EM::Connection
+      include EM::Socksify
+
+      def connection_completed
+        socksify('google.ca', 80) do
+          send_data "GET / HTTP/1.1\r\nConnection:close\r\nHost: google.ca\r\n\r\n"
+        end
+      end
+
+      def receive_data(data)
+        p data
+      end
+    end
+
+    EM.run do
+      EventMachine.connect SOCKS_HOST, SOCKS_PORT, Handler
+    end
+
+What's happening here? First, we open a raw TCP connection to the SOCKS proxy (after all, all data will flow through it). Then, we provide a Handler connection class, which includes "EM::Socksify". Once the TCP connection is established, EventMachine calls the **connection_completed** method in our handler. Here, we call socksify with the actual destination host & port (address that we actually want to get to), and the module does the rest.
+
+After you call socksify, the module temporarily intercepts your receive_data callbacks, negotiates the SOCKS connection (version, authentication, etc), and then once all is done, returns the control back to your code. Simple as that.
+
+For SOCKS proxies which require authentication, use:
+
+    socksify(destination_host, destination_port, username, password)
+
+
+## Wishlist
+
+- IPV6 support
+- SOCKS4 support
+
+## Resources
+
+- [SOCKS on Wikipedia](http://en.wikipedia.org/wiki/SOCKS)
+- [Socksify-Ruby](https://github.com/astro/socksify-ruby) for regular Ruby TCPSocket
+
+# License
+
+(The MIT License)
+Copyright © 2011 Ilya Grigorik

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/em-socksify.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-socksify/version"
+
+Gem::Specification.new do |s|
+  s.name        = "em-socksify"
+  s.version     = EventMachine::Socksify::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ilya Grigorik"]
+  s.email       = ["ilya@igvita.com"]
+  s.homepage    = "http://github.com/igrigorik/em-socksify"
+  s.summary     = "EventMachine SOCKSify shim: adds SOCKS support to any protocol"
+  s.description = s.summary
+
+  s.rubyforge_project = "em-socksify"
+
+  s.add_dependency "eventmachine"
+  s.add_development_dependency "rspec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/em-socksify/socksify.rb

@@ -0,0 +1,122 @@
+module EventMachine
+  module Socksify
+
+    def socksify(host, port, username = nil, password = nil, &blk)
+      @host = host
+      @port = port
+      @username = username
+      @password = password
+      @callback = blk
+
+      class << self
+        def receive_data(data); proxy_receive_data(data); end
+      end
+
+      send_socks_handshake
+    end
+
+    def proxy_receive_data(data)
+      @data ||= ''
+      @data << data
+      parse_socks_response
+    end
+
+    def send_socks_handshake
+      # Method Negotiation as described on
+      # http://www.faqs.org/rfcs/rfc1928.html Section 3
+      @socks_state = :method_negotiation
+
+      methods = socks_methods
+      send_data [5, methods.size].pack('CC') + methods.pack('C*')
+    end
+
+    def send_socks_connect_request
+      begin
+        # TO-DO: Implement address types for IPv6 and Domain
+        ip_address = Socket.gethostbyname(@host).last
+        send_data [5, 1, 0, 1, ip_address, @port].flatten.pack('CCCCA4n')
+
+      rescue
+        fail("could not resolve host")
+      end
+    end
+
+    private
+
+      # parses socks 5 server responses as specified
+      # on http://www.faqs.org/rfcs/rfc1928.html
+      def parse_socks_response
+        if @socks_state == :method_negotiation
+          return if not @data.size >= 2
+
+          _, method = @data.slice!(0,2).unpack('CC')
+
+          if socks_methods.include?(method)
+            if method == 0
+              @socks_state = :connecting
+              send_socks_connect_request
+
+            elsif method == 2
+              @socks_state = :authenticating
+              send_data [5, @username.length, @username, @password.length, @password].pack('CCA*CA*')
+            end
+
+          else
+            fail("proxy did not accept method")
+          end
+
+        elsif @socks_state == :authenticating
+          return if not @data.size >= 2
+
+          _, status_code = @data.slice!(0, 2).unpack('CC')
+
+          if status_code == 0 # success
+            @socks_state = :connecting
+            send_socks_connect_request
+
+          else # error
+            fail "access denied by proxy"
+          end
+
+        elsif @socks_state == :connecting
+          return if not @data.size >= 10
+
+          _, response_code, _, address_type, _, _ = @data.slice(0, 10).unpack('CCCCNn')
+
+          if response_code == 0 # success
+            @socks_state = :connected
+
+            class << self
+              remove_method :receive_data
+            end
+
+            @callback.call
+
+          else # error
+            error_messages = {
+              1 => "general socks server failure",
+              2 => "connection not allowed by ruleset",
+              3 => "network unreachable",
+              4 => "host unreachable",
+              5 => "connection refused",
+              6 => "TTL expired",
+              7 => "command not supported",
+              8 => "address type not supported"
+            }
+
+            error_message = error_messages[response_code] || "unknown error (code: #{response_code})"
+            fail "socks5 connect error: #{error_message}"
+          end
+        end
+      end
+
+      def socks_methods
+        methods = []
+        methods << 2 if !@username.nil? # 2 => Username/Password Authentication
+        methods << 0 # 0 => No Authentication Required
+
+        methods
+      end
+
+  end
+end

data/lib/em-socksify/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  module Socksify
+    VERSION = "0.1.0"
+  end
+end

data/lib/em-socksify.rb

@@ -0,0 +1,3 @@
+require 'eventmachine'
+
+require 'em-socksify/socksify'

data/spec/helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'em-socksify'

data/spec/socksify_spec.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+describe EventMachine do
+
+  it "should negotiate a socks connection" do
+
+    class Handler < EM::Connection
+      include EM::Socksify
+
+      def connection_completed
+        socksify('google.ca', 80) do
+          send_data "GET / HTTP/1.1\r\nConnection:close\r\nHost: google.ca\r\n\r\n"
+        end
+      end
+
+      def receive_data(data)
+        @received ||= ''
+        @received << data
+      end
+
+      def unbind
+        @received.size.should > 0
+        @received[0,4].should == 'HTTP'
+        EM.stop
+      end
+    end
+
+    EM.run do
+      EventMachine.connect '127.0.0.1', 8080, Handler
+    end
+  end
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: em-socksify
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ilya Grigorik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: "EventMachine SOCKSify shim: adds SOCKS support to any protocol"
+email: 
+- ilya@igvita.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- em-socksify.gemspec
+- lib/em-socksify.rb
+- lib/em-socksify/socksify.rb
+- lib/em-socksify/version.rb
+- spec/helper.rb
+- spec/socksify_spec.rb
+has_rdoc: true
+homepage: http://github.com/igrigorik/em-socksify
+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: em-socksify
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: "EventMachine SOCKSify shim: adds SOCKS support to any protocol"
+test_files: 
+- spec/helper.rb
+- spec/socksify_spec.rb