em-socksify 0.2.1 → 0.3.0

data/README.md

@@ -1,8 +1,8 @@
-# EM-Socksify: Transparent SOCKS support for any EventMachine protocol
+# Transparent proxy 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.
+Dealing with SOCKS and HTTP proxies is a pain. EM-Socksify provides a simple ship to setup and negotiation a SOCKS / HTTP connection for any EventMachine protocol.
 
-## Example: Routing HTTP request via SOCKS5 proxy
+### Example: Routing HTTP request via SOCKS5 proxy
 
 ```ruby
 class Handler < EM::Connection
@@ -24,9 +24,9 @@ EM.run do
 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.
+What's happening here? First, we open a raw TCP connection to the SOCKS proxy. Once the TCP connection is established, EventMachine calls the **connection_completed** method in our handler, at which point we call the helper method (**socksify**) with the actual destination and host and 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.
+socksify temporarily intercepts your receive_data callbacks, negotiates the SOCKS connection (version, authentication, etc), and then once all of that is done, returns control back to your code.
 
 For SOCKS proxies which require authentication, use:
 
@@ -34,17 +34,51 @@ For SOCKS proxies which require authentication, use:
 socksify(destination_host, destination_port, username, password, version)
 ```
 
-## Wishlist
+### Example: Routing HTTPS request via a squid CONNECT proxy
+
+```ruby
+class Handler < EM::Connection
+  include EM::Connectify
+
+  def connection_completed
+    connectify('www.google.ca', 443) do
+      start_tls
+      send_data "GET / HTTP/1.1\r\nConnection:close\r\nHost: www.google.ca\r\n\r\n"
+    end
+  end
+
+  def receive_data(data)
+    p data
+  end
+end
+
+EM.run do
+  EventMachine.connect PROXY_HOST, PROXY_PORT, Handler
+end
+```
+
+For CONNECT proxies which require authentication, use:
+
+```ruby
+connectify(destination_host, destination_port, username, password)
+```
+
+### Wishlist
 
 - IPV6 support
 - SOCKS4 support
 
-## Resources
+### Resources
 
 - [SOCKS on Wikipedia](http://en.wikipedia.org/wiki/SOCKS)
 - [Socksify-Ruby](https://github.com/astro/socksify-ruby) for regular Ruby TCPSocket
+- [HTTP Connect Tunneling](http://en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_Tunneling)
+
+### Contributors
+
+- [Ilya Grigorik](https://github.com/igrigorik)
+- [Conrad Irwin](https://github.com/ConradIrwin)
 
-# License
+### License
 
 (The MIT License)
-Copyright © 2011 Ilya Grigorik

data/em-socksify.gemspec

@@ -9,13 +9,14 @@ Gem::Specification.new do |s|
   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.summary     = "Transparent proxy support for any EventMachine protocol"
   s.description = s.summary
 
   s.rubyforge_project = "em-socksify"
 
   s.add_dependency "eventmachine", ">= 1.0.0.beta.4"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/em-socksify.rb

@@ -1,5 +1,15 @@
 require 'eventmachine'
+require 'base64'
 
 require 'em-socksify/socksify'
 require 'em-socksify/errors'
 require 'em-socksify/socks5'
+require 'em-socksify/connectify'
+require 'em-socksify/connect'
+
+# Backport from ruby-1.9 to ruby-1.8 (which doesn't support pack('m0') either)
+unless Base64.respond_to?(:strict_encode64)
+  def Base64.strict_encode64(str)
+    Base64.encode64(str).gsub("\n", "")
+  end
+end

data/lib/em-socksify/connect.rb

@@ -0,0 +1,28 @@
+module EventMachine
+  module Connectify
+    module CONNECT
+      def connect_send_handshake
+        header =  "CONNECT #{@connect_target_host}:#{@connect_target_port} HTTP/1.0\r\n"
+        if @connect_username || @connect_password
+          encoded_credentials = Base64.strict_encode64([@connect_username, @connect_password].join(":"))
+          header << "Proxy-Authorization: Basic #{encoded_credentials}\r\n"
+        end
+
+        header << "\r\n"
+        send_data(header)
+      end
+
+      private
+
+      def connect_parse_response
+        unless @connect_data =~ %r{\AHTTP/1\.[01] 200 .*\r\n\r\n}m
+          raise CONNECTError.new, "Unexpected response: #{@connect_data}"
+        end
+
+        connect_unhook
+      rescue => e
+        @connect_deferrable.fail e
+      end
+    end
+  end
+end

data/lib/em-socksify/connectify.rb

@@ -0,0 +1,41 @@
+module EventMachine
+
+  module Connectify
+    def connectify(host, port, username=nil, password=nil, &blk)
+      @connect_target_host = host
+      @connect_target_port = port
+      @connect_username = username
+      @connect_password = password
+      @connect_data = ''
+
+      connect_hook
+      connect_send_handshake
+
+      @connect_deferrable = DefaultDeferrable.new
+      @connect_deferrable.callback(&blk) if blk
+      @connect_deferrable
+    end
+
+    def connect_hook
+      extend CONNECT
+
+      class << self
+        alias receive_data connect_receive_data
+      end
+    end
+
+    def connect_unhook
+      class << self
+        remove_method :receive_data
+      end
+
+      @connect_deferrable.succeed
+    end
+
+    def connect_receive_data(data)
+      @connect_data << data
+      connect_parse_response
+    end
+  end
+
+end

data/lib/em-socksify/errors.rb

@@ -35,4 +35,9 @@ module EventMachine
     end
 
   end
+
+  module Connectify
+    class CONNECTError < Exception
+    end
+  end
 end

data/lib/em-socksify/version.rb

@@ -1,7 +1,5 @@
 module EventMachine
-
-module Socksify
-  VERSION = "0.2.1"
-end
-
+  module Socksify
+    VERSION = "0.3.0"
+  end
 end

data/spec/socksify_spec.rb

@@ -2,14 +2,15 @@ require 'helper'
 
 describe EventMachine do
 
+  # requires: ssh -D 8080 localhost
   it "should negotiate a socks connection" do
 
     class Handler < EM::Connection
       include EM::Socksify
 
       def connection_completed
-        socksify('google.ca', 80) do |ip|
-          send_data "GET / HTTP/1.1\r\nConnection:close\r\nHost: google.ca\r\n\r\n"
+        socksify('google.com', 80) do |ip|
+          send_data "GET / HTTP/1.1\r\nConnection:close\r\nHost: google.com\r\n\r\n"
         end
       end
 
@@ -30,4 +31,35 @@ describe EventMachine do
     end
   end
 
+  # requires squid running on localhost with default config
+  it "should negotiate a connect connection" do
+
+    class Handler < EM::Connection
+      include EM::Connectify
+
+      def connection_completed
+        connectify('www.google.com', 443) do
+          start_tls
+          send_data "GET / HTTP/1.1\r\nConnection:close\r\nHost: www.google.com\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', 8081, Handler
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-socksify
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-11 00:00:00.000000000 Z
+date: 2013-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -43,7 +43,23 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'EventMachine SOCKSify shim: adds SOCKS support to any protocol'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Transparent proxy support for any EventMachine protocol
 email:
 - ilya@igvita.com
 executables: []
@@ -51,12 +67,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
 - Gemfile
 - README.md
 - Rakefile
 - em-socksify.gemspec
 - lib/em-socksify.rb
+- lib/em-socksify/connect.rb
+- lib/em-socksify/connectify.rb
 - lib/em-socksify/errors.rb
 - lib/em-socksify/socks5.rb
 - lib/em-socksify/socksify.rb
@@ -86,7 +103,7 @@ rubyforge_project: em-socksify
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ! 'EventMachine SOCKSify shim: adds SOCKS support to any protocol'
+summary: Transparent proxy support for any EventMachine protocol
 test_files:
 - spec/helper.rb
 - spec/socksify_spec.rb