em-socksify 0.1.0 → 0.2.0

data/README.md

@@ -4,23 +4,25 @@ Dealing with SOCKS proxies is pain. EM-Socksify provides a simple shim to setup
 
 ## 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
+```ruby
+class Handler < EM::Connection
+  include EM::Socksify
 
-    EM.run do
-      EventMachine.connect SOCKS_HOST, SOCKS_PORT, Handler
+  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.
 
@@ -28,8 +30,9 @@ After you call socksify, the module temporarily intercepts your receive_data cal
 
 For SOCKS proxies which require authentication, use:
 
-    socksify(destination_host, destination_port, username, password)
-
+```ruby
+socksify(destination_host, destination_port, username, password, version)
+```
 
 ## Wishlist
 
@@ -44,4 +47,4 @@ For SOCKS proxies which require authentication, use:
 # License
 
 (The MIT License)
-Copyright © 2011 Ilya Grigorik
+Copyright © 2011 Ilya Grigorik

data/Rakefile

@@ -1,2 +1,7 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)

data/em-socksify.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "em-socksify"
 
-  s.add_dependency "eventmachine"
+  s.add_dependency "eventmachine", ">= 1.0.0.beta.4"
   s.add_development_dependency "rspec"
 
   s.files         = `git ls-files`.split("\n")

data/lib/em-socksify.rb

@@ -1,3 +1,5 @@
 require 'eventmachine'
 
-require 'em-socksify/socksify'
+require 'em-socksify/socksify'
+require 'em-socksify/errors'
+require 'em-socksify/socks5'

data/lib/em-socksify/errors.rb

@@ -0,0 +1,38 @@
+module EventMachine
+  module Socksify
+
+    class SOCKSError < Exception
+      def self.define (message)
+        Class.new(self) do
+          def initialize
+            super(message)
+          end
+        end
+      end
+
+      ServerFailure           = define('general SOCKS server failure')
+      NotAllowed              = define('connection not allowed by ruleset')
+      NetworkUnreachable      = define('Network unreachable')
+      HostUnreachable         = define('Host unreachable')
+      ConnectionRefused       = define('Connection refused')
+      TTLExpired              = define('TTL expired')
+      CommandNotSupported     = define('Command not supported')
+      AddressTypeNotSupported = define('Address type not supported')
+
+      def self.for_response_code(code)
+        case code.is_a?(String) ? code.ord : code
+        when 1 then ServerFailure
+        when 2 then NotAllowed
+        when 3 then NetworkUnreachable
+        when 4 then HostUnreachable
+        when 5 then ConnectionRefused
+        when 6 then TTLExpired
+        when 7 then CommandNotSupported
+        when 8 then AddressTypeNotSupported
+        else self
+        end
+      end
+    end
+
+  end
+end

data/lib/em-socksify/socks5.rb

@@ -0,0 +1,115 @@
+module EventMachine
+  module Socksify
+
+    module SOCKS5
+      def socks_send_handshake
+        # Method Negotiation as described on
+        # http://www.faqs.org/rfcs/rfc1928.html Section 3
+        @socks_state = :method_negotiation
+
+        socks_methods.tap do |methods|
+          send_data [5, methods.size].pack('CC') + methods.pack('C*')
+        end
+      end
+
+      def socks_send_connect_request
+        @socks_state = :connecting
+
+        send_data [5, 1, 0].pack('CCC')
+
+        if matches = @socks_target_host.match(/^(\d+)\.(\d+)\.(\d+)\.(\d+)$/)
+          send_data "\xF1\x00\x01" + matches.to_a[1 .. -1].map { |s| s.to_i }.pack('CCCC')
+
+        elsif @socks_target_host =~ /^[:0-9a-f]+$/
+          raise SOCKSError, 'TCP/IPv6 over SOCKS is not yet supported (inet_pton missing in Ruby & not supported by Tor)'
+
+        else
+          send_data [3, @socks_target_host.size, @socks_target_host].pack('CCA*')
+        end
+
+        send_data [@socks_target_port].pack('n')
+      end
+
+      def socks_send_authentication
+        @socks_state = :authenticating
+
+        send_data [5,
+                   @socks_username.length, @socks_username,
+                   @socks_password.length, @socks_password
+                   ].pack('CCA*CA*')
+      end
+
+      private
+
+        # parses socks 5 server responses as specified
+        # on http://www.faqs.org/rfcs/rfc1928.html
+        def socks_parse_response
+          case @socks_state
+          when :method_negotiation
+            return unless @socks_data.size >= 2
+
+            _, method = @socks_data.slice!(0, 2).unpack('CC')
+
+            if socks_methods.include?(method)
+              case method
+              when 0 then socks_send_connect_request
+              when 2 then socks_send_authentication
+              end
+            else
+              raise SOCKSError, 'proxy did not accept method'
+            end
+
+          when :authenticating
+            return unless @socks_data.size >= 2
+
+            socks_version, status_code = @socks_data.slice!(0, 2).unpack('CC')
+
+            raise SOCKSError, "SOCKS version 5 not supported" unless socks_version == 5
+            raise SOCKSError, 'access denied by proxy'        unless status_code == 0
+
+            send_socks_connect_request
+
+          when :connecting
+            return unless @socks_data.size >= 2
+
+            socks_version, status_code = @socks_data.slice(0, 2).unpack('CC')
+
+            raise SOCKSError, "SOCKS version #{socks_version} is not 5" unless socks_version == 5
+            raise SOCKSError.for_response_code(status_code)             unless status_code == 0
+
+            min_size = @socks_data[3].ord == 3 ? 5 : 4
+
+            return unless @socks_data.size >= min_size
+
+            size = case @socks_data[3].ord
+            when 1 then 4
+            when 3 then @socks_data[4].ord
+            when 4 then 16
+            else raise SOCKSError.for_response_code(@socks_data[3])
+            end
+
+            return unless @socks_data.size >= (min_size + size)
+
+            bind_addr = @socks_data.slice(min_size, size)
+
+            ip = case @socks_data[3].ord
+            when 1 then bind_addr.bytes.to_a.join('.')
+            when 3 then bind_addr
+            when 4 then # TODO: ???
+            end
+
+            socks_unhook(ip)
+          end
+        end
+
+        def socks_methods
+          methods = []
+          methods << 2 if !@socks_username.nil? # 2 => Username/Password Authentication
+          methods << 0 # 0 => No Authentication Required
+
+          methods
+        end
+    end
+
+  end
+end

data/lib/em-socksify/socksify.rb

@@ -1,122 +1,43 @@
 module EventMachine
+
   module Socksify
+    def socksify(host, port, username = nil, password = nil, version = 5, &blk)
+      @socks_target_host = host
+      @socks_target_port = port
+      @socks_username = username
+      @socks_password = password
+      @socks_version = version
+      @socks_callback = blk
+      @socks_data = ''
+
+      socks_hook
+      socks_send_handshake
+    end
 
-    def socksify(host, port, username = nil, password = nil, &blk)
-      @host = host
-      @port = port
-      @username = username
-      @password = password
-      @callback = blk
+    def socks_hook
+      if @socks_version == 5
+        extend SOCKS5
+      else
+        raise ArgumentError, 'SOCKS version unsupported'
+      end
 
       class << self
-        def receive_data(data); proxy_receive_data(data); end
+        alias receive_data socks_receive_data
       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
+    def socks_unhook(ip = nil)
+      class << self
+        remove_method :receive_data
+      end
 
-      methods = socks_methods
-      send_data [5, methods.size].pack('CC') + methods.pack('C*')
+      @socks_callback.call(ip)
     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
+    def socks_receive_data(data)
+      @socks_data << data
+      socks_parse_response
     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
+
+end

data/lib/em-socksify/version.rb

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

data/spec/socksify_spec.rb

@@ -8,7 +8,7 @@ describe EventMachine do
       include EM::Socksify
 
       def connection_completed
-        socksify('google.ca', 80) do
+        socksify('google.ca', 80) do |ip|
           send_data "GET / HTTP/1.1\r\nConnection:close\r\nHost: google.ca\r\n\r\n"
         end
       end
@@ -30,4 +30,4 @@ describe EventMachine do
     end
   end
 
-end
+end

metadata

@@ -1,56 +1,45 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: em-socksify
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ilya Grigorik
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-23 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: eventmachine
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: &2156395280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.4
   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"
+  version_requirements: *2156395280
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156394860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: "EventMachine SOCKSify shim: adds SOCKS support to any protocol"
-email: 
+  prerelease: false
+  version_requirements: *2156394860
+description: ! 'EventMachine SOCKSify shim: adds SOCKS support to any protocol'
+email:
 - ilya@igvita.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
@@ -58,40 +47,37 @@ files:
 - Rakefile
 - em-socksify.gemspec
 - lib/em-socksify.rb
+- lib/em-socksify/errors.rb
+- lib/em-socksify/socks5.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: 
+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"
+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: em-socksify
-rubygems_version: 1.3.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: "EventMachine SOCKSify shim: adds SOCKS support to any protocol"
-test_files: 
+summary: ! 'EventMachine SOCKSify shim: adds SOCKS support to any protocol'
+test_files:
 - spec/helper.rb
 - spec/socksify_spec.rb
+has_rdoc: