websocket-driver 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a13b9adf6ecd4d2e375153c60898f884fb60de1
-  data.tar.gz: adf67dbc8b4eb9f4c582531f026b03c029a596cd
+  metadata.gz: 8bb8b233ccc5e031bc6da97c6c716ed50aab3d07
+  data.tar.gz: 47be97004eb7ff7714b91d1e970b14fa53a8adb9
 SHA512:
-  metadata.gz: 40a8dffd61f2aeb1ebb28ca1d368a6bbbc66ab6422d4a7ba68afec740e456d2bf20a783353ce3c0bda0f43dbbbb9a42d68cd61c5c43744647ce544b0049daadd
-  data.tar.gz: 1b93c39aaa658aaf9c736307a4a7e3866768e7c1703aa981b9603a50e76798297aecfc7c20a09699cf96e9d2eb0e24257db90a245bc11ecf9898549ea6211a1a
+  metadata.gz: 7b48d1dd1e68a35529b77f1f775146e6ea40961939ec124e2c31f42356473a9071533e61465574a0ddc2e8f482908316f36775c5a02f9447c8839ca435ff9b17
+  data.tar.gz: 2d07d08ae2caa027f6b22d07325bcb2ba509c2d9349362731ef34a3f47396fc29ef3ebccb60afba594740b8e024b7d09162115695eaf094f2063d606d74f28cb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.4.0 / 2014-11-08
+
+* Support connection via HTTP proxies using `CONNECT`
+
 ### 0.3.5 / 2014-10-04
 
 * Fix bug where the `Server` driver doesn't pass `ping` callbacks to its delegate

data/README.md

@@ -193,6 +193,51 @@ sent back by the server:
 * `driver.headers` - a hash-like object containing the response headers
 
 
+### HTTP Proxies
+
+The client driver supports connections via HTTP proxies using the `CONNECT`
+method. Instead of sending the WebSocket handshake immediately, it will send a
+`CONNECT` request, wait for a `200` response, and then proceed as normal.
+
+To use this feature, call `proxy = driver.proxy(url)` where `url` is the origin
+of the proxy, including a username and password if required. This produces an
+object that manages the process of connecting via the proxy. You should call
+`proxy.start` to begin the connection process, and pass data you receive via the
+socket to `proxy.parse(data)`. When the proxy emits `:connect`, you should then
+start sending incoming data to `driver.parse(data)` as normal, and call
+`driver.start`.
+
+```rb
+proxy = driver.proxy('http://username:password@proxy.example.com')
+
+proxy.on :connect do
+  driver.start
+end
+```
+
+The proxy's `:connect` event is also where you should perform a TLS handshake on
+your TCP stream, if you are connecting to a `wss:` endpoint.
+
+In the event that proxy connection fails, `proxy` will emit an `:error`. You can
+inspect the proxy's response via `proxy.status` and `proxy.headers`.
+
+```rb
+proxy.on :error do |error|
+  puts error.message
+  puts proxy.status
+  puts proxy.headers.inspect
+end
+```
+
+Before calling `proxy.start` you can set custom headers using
+`proxy.set_header`:
+
+```rb
+proxy.set_header('User-Agent', 'ruby')
+proxy.start
+```
+
+
 ### Driver API
 
 Drivers are created using one of the following methods:

data/ext/websocket-driver/websocket_mask.c

@@ -13,19 +13,20 @@ void Init_websocket_mask() {
 }
 
 VALUE method_websocket_mask(VALUE self, VALUE payload, VALUE mask) {
+  int n, i, p, m;
+  int mask_array[4];
+  VALUE unmasked;
+
   if (mask == Qnil || RARRAY_LEN(mask) == 0) {
     return payload;
   }
 
-  int n = RARRAY_LEN(payload), i, p, m;
-  VALUE unmasked = rb_ary_new2(n);
+  n = RARRAY_LEN(payload);
+  unmasked = rb_ary_new2(n);
 
-  int mask_array[] = {
-    NUM2INT(rb_ary_entry(mask, 0)),
-    NUM2INT(rb_ary_entry(mask, 1)),
-    NUM2INT(rb_ary_entry(mask, 2)),
-    NUM2INT(rb_ary_entry(mask, 3))
-  };
+  for (i = 0; i < 4; i++) {
+    mask_array[i] = NUM2INT(rb_ary_entry(mask, i));
+  }
 
   for (i = 0; i < n; i++) {
     p = NUM2INT(rb_ary_entry(payload, i));

data/lib/websocket/driver.rb

@@ -51,6 +51,7 @@ module WebSocket
     autoload :EventEmitter, root + '/event_emitter'
     autoload :Headers,      root + '/headers'
     autoload :Hybi,         root + '/hybi'
+    autoload :Proxy,        root + '/proxy'
     autoload :Server,       root + '/server'
 
     include EventEmitter

data/lib/websocket/driver/client.rb

@@ -15,12 +15,36 @@ module WebSocket
         @key         = Client.generate_key
         @accept      = Hybi.generate_accept(@key)
         @http        = HTTP::Response.new
+
+        uri       = URI.parse(@socket.url)
+        host      = uri.host + (uri.port ? ":#{uri.port}" : '')
+        path      = (uri.path == '') ? '/' : uri.path
+        @pathname = path + (uri.query ? '?' + uri.query : '')
+
+        @headers['Host'] = host
+        @headers['Upgrade'] = 'websocket'
+        @headers['Connection'] = 'Upgrade'
+        @headers['Sec-WebSocket-Key'] = @key
+        @headers['Sec-WebSocket-Version'] = '13'
+
+        if @protocols.size > 0
+          @headers['Sec-WebSocket-Protocol'] = @protocols * ', '
+        end
+
+        if uri.user
+          auth = Base64.encode64([uri.user, uri.password] * ':').gsub(/\n/, '')
+          @headers['Authorization'] = 'Basic ' + auth
+        end
       end
 
       def version
         'hybi-13'
       end
 
+      def proxy(origin, options = {})
+        Proxy.new(self, origin, options)
+      end
+
       def start
         return false unless @ready_state == -1
         @socket.write(Driver.encode(handshake_request, :binary))
@@ -30,8 +54,10 @@ module WebSocket
 
       def parse(buffer)
         return super if @ready_state > 0
+
         @http.parse(buffer)
         return fail_handshake('Invalid HTTP response') if @http.error?
+
         validate_handshake if @http.complete?
         parse(@http.body) if @ready_state == 1
       end
@@ -39,29 +65,9 @@ module WebSocket
     private 
 
       def handshake_request
-        uri   = URI.parse(@socket.url)
-        host  = uri.host + (uri.port ? ":#{uri.port}" : '')
-        path  = (uri.path == '') ? '/' : uri.path
-        query = uri.query ? "?#{uri.query}" : ''
-
-        headers = [ "GET #{path}#{query} HTTP/1.1",
-                    "Host: #{host}",
-                    "Upgrade: websocket",
-                    "Connection: Upgrade",
-                    "Sec-WebSocket-Key: #{@key}",
-                    "Sec-WebSocket-Version: 13"
-                  ]
-
-        if @protocols.size > 0
-          headers << "Sec-WebSocket-Protocol: #{@protocols * ', '}"
-        end
-
-        if uri.user
-          auth = Base64.encode64([uri.user, uri.password] * ':').gsub(/\n/, '')
-          headers << "Authorization: Basic #{auth}"
-        end
-
-        (headers + [@headers.to_s, '']).join("\r\n")
+        start   = "GET #{@pathname} HTTP/1.1"
+        headers = [start, @headers.to_s, '']
+        headers.join("\r\n")
       end
 
       def fail_handshake(message)

data/lib/websocket/driver/draft75.rb

@@ -5,6 +5,11 @@ module WebSocket
       def initialize(socket, options = {})
         super
         @stage = 0
+
+        @headers['Upgrade'] = 'WebSocket'
+        @headers['Connection'] = 'Upgrade'
+        @headers['WebSocket-Origin'] = @socket.env['HTTP_ORIGIN']
+        @headers['WebSocket-Location'] = @socket.url
       end
 
       def version
@@ -73,14 +78,9 @@ module WebSocket
     private
 
       def handshake_response
-        upgrade =  "HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
-        upgrade << "Upgrade: WebSocket\r\n"
-        upgrade << "Connection: Upgrade\r\n"
-        upgrade << "WebSocket-Origin: #{@socket.env['HTTP_ORIGIN']}\r\n"
-        upgrade << "WebSocket-Location: #{@socket.url}\r\n"
-        upgrade << @headers.to_s
-        upgrade << "\r\n"
-        upgrade
+        start   = 'HTTP/1.1 101 Web Socket Protocol Handshake'
+        headers = [start, @headers.to_s, '']
+        headers.join("\r\n")
       end
 
       def parse_leading_byte(data)

data/lib/websocket/driver/draft76.rb

@@ -9,6 +9,12 @@ module WebSocket
         input  = @socket.env['rack.input']
         @stage = -1
         @body  = input ? input.read.bytes.to_a : []
+
+        @headers.clear
+        @headers['Upgrade'] = 'WebSocket'
+        @headers['Connection'] = 'Upgrade'
+        @headers['Sec-WebSocket-Origin'] = @socket.env['HTTP_ORIGIN']
+        @headers['Sec-WebSocket-Location'] = @socket.url
       end
 
       def version
@@ -32,14 +38,9 @@ module WebSocket
     private
 
       def handshake_response
-        upgrade =  "HTTP/1.1 101 WebSocket Protocol Handshake\r\n"
-        upgrade << "Upgrade: WebSocket\r\n"
-        upgrade << "Connection: Upgrade\r\n"
-        upgrade << "Sec-WebSocket-Origin: #{@socket.env['HTTP_ORIGIN']}\r\n"
-        upgrade << "Sec-WebSocket-Location: #{@socket.url}\r\n"
-        upgrade << @headers.to_s
-        upgrade << "\r\n"
-        upgrade
+        start   = 'HTTP/1.1 101 WebSocket Protocol Handshake'
+        headers = [start, @headers.to_s, '']
+        headers.join("\r\n")
       end
 
       def handshake_signature

data/lib/websocket/driver/headers.rb

@@ -6,13 +6,17 @@ module WebSocket
 
       def initialize(received = {})
         @raw   = received
-        @sent  = Set.new
-        @lines = []
+        clear
 
         @received = {}
         @raw.each { |k,v| @received[HTTP.normalize_header(k)] = v }
       end
 
+      def clear
+        @sent  = Set.new
+        @lines = []
+      end
+
       def [](name)
         @received[HTTP.normalize_header(name)]
       end

data/lib/websocket/driver/hybi.rb

@@ -62,9 +62,17 @@ module WebSocket
 
         return unless @socket.respond_to?(:env)
 
+        sec_key = @socket.env['HTTP_SEC_WEBSOCKET_KEY']
+        protos  = @socket.env['HTTP_SEC_WEBSOCKET_PROTOCOL']
+
+        @headers['Upgrade'] = 'websocket'
+        @headers['Connection'] = 'Upgrade'
+        @headers['Sec-WebSocket-Accept'] = Hybi.generate_accept(sec_key)
+
         if protos = @socket.env['HTTP_SEC_WEBSOCKET_PROTOCOL']
           protos = protos.split(/\s*,\s*/) if String === protos
           @protocol = protos.find { |p| @protocols.include?(p) }
+          @headers['Sec-WebSocket-Protocol'] = @protocol if @protocol
         end
       end
 
@@ -197,21 +205,9 @@ module WebSocket
     private
 
       def handshake_response
-        sec_key = @socket.env['HTTP_SEC_WEBSOCKET_KEY']
-        return '' unless String === sec_key
-
-        headers = [
-          "HTTP/1.1 101 Switching Protocols",
-          "Upgrade: websocket",
-          "Connection: Upgrade",
-          "Sec-WebSocket-Accept: #{Hybi.generate_accept(sec_key)}"
-        ]
-
-        if @protocol
-          headers << "Sec-WebSocket-Protocol: #{@protocol}"
-        end
-
-        (headers + [@headers.to_s, '']).join("\r\n")
+        start   = 'HTTP/1.1 101 Switching Protocols'
+        headers = [start, @headers.to_s, '']
+        headers.join("\r\n")
       end
 
       def shutdown(code, reason)

data/lib/websocket/driver/proxy.rb

@@ -0,0 +1,68 @@
+module WebSocket
+  class Driver
+
+    class Proxy
+      include EventEmitter
+
+      PORTS = {'ws' => 80, 'wss' => 443}
+
+      attr_reader :status, :headers
+
+      def initialize(client, origin, options)
+        super()
+
+        @client  = client
+        @http    = HTTP::Response.new
+        @socket  = client.instance_variable_get(:@socket)
+        @origin  = URI.parse(@socket.url)
+        @url     = URI.parse(origin)
+        @options = options
+        @state   = 0
+
+        @headers = Headers.new
+        @headers['Host'] = @origin.host + (@origin.port ? ":#{@origin.port}" : '')
+        @headers['Connection'] = 'keep-alive'
+        @headers['Proxy-Connection'] = 'keep-alive'
+
+        if @url.user
+          auth = Base64.encode64([@url.user, @url.password] * ':').gsub(/\n/, '')
+          @headers['Proxy-Authorization'] = 'Basic ' + auth
+        end
+      end
+
+      def set_header(name, value)
+        return false unless @state == 0
+        @headers[name] = value
+        true
+      end
+
+      def start
+        return false unless @state == 0
+        @state = 1
+
+        port    = @origin.port || PORTS[@origin.scheme]
+        start   = "CONNECT #{@origin.host}:#{port} HTTP/1.1"
+        headers = [start, @headers.to_s, '']
+
+        @socket.write(headers.join("\r\n"))
+        true
+      end
+
+      def parse(buffer)
+        @http.parse(buffer)
+        return unless @http.complete?
+
+        @status = @http.code
+        @headers = Headers.new(@http.headers)
+
+        if @status == 200
+          emit(:connect)
+        else
+          message = "Can't establish a connection to the server at #{@socket.url}"
+          emit(:error, ProtocolError.new(message))
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - James Coglan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-04 00:00:00.000000000 Z
+date: 2014-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -74,6 +74,7 @@ files:
 - lib/websocket/driver/headers.rb
 - lib/websocket/driver/hybi.rb
 - lib/websocket/driver/hybi/stream_reader.rb
+- lib/websocket/driver/proxy.rb
 - lib/websocket/driver/server.rb
 - lib/websocket/driver/utf8_match.rb
 - lib/websocket/http.rb