websocket-driver 0.3.1 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 826108e30bdbc4629bcd1ef1c6b8029f9e4fed1b
+  data.tar.gz: e117f305de4f1e50f7046e32605538cbbec763c7
+SHA512:
+  metadata.gz: b0d72d49469e28e6245e3df38a4769b834fb83bc5b5185ee51a32b15178dcd4b247810a0c507b190eb6e0e6411e20a9a3ccd48c0b29ead666c83b3307160bfb4
+  data.tar.gz: 15dd9190ce6ba1d40961820951c4056f60602ddac2d7d5d1c97923584a416b49a0b62d968eed95cf5eb8de7715170f999d18afb93c0fa92fd749e0c210ee16f0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.3.2 / 2013-12-29
+
+* Expand `max_length` to cover sequences of continuation frames and `draft-{75,76}`
+* Decrease default maximum frame buffer size to 64MB
+* Stop parsing when the protocol enters a failure mode, to save CPU cycles
+
 ### 0.3.1 / 2013-12-03
 
 * Add a `max_length` option to limit allowed frame size

data/README.md

@@ -213,7 +213,7 @@ The `options` argument is optional, and is a hash. It may contain the following
 keys:
 
 * `:max_length` - the maximum allowed size of incoming message frames, in bytes.
-  The default value is `2^30 - 1`, or 1 byte short of 1GiB.
+  The default value is `2^26 - 1`, or 1 byte short of 64 MiB.
 * `:protocols` - an array of strings representing acceptable subprotocols for
   use over the socket. The driver will negotiate one of these to use via the
   `Sec-WebSocket-Protocol` header if supported by the other peer.

data/lib/websocket/driver.rb

@@ -35,7 +35,8 @@ module WebSocket
       require root + '/utf8_match'
     end
 
-    STATES = [:connecting, :open, :closing, :closed]
+    MAX_LENGTH = 0x3ffffff
+    STATES     = [:connecting, :open, :closing, :closed]
 
     class ConnectEvent < Struct.new(nil) ; end
     class OpenEvent    < Struct.new(nil) ; end
@@ -60,6 +61,7 @@ module WebSocket
 
       @socket      = socket
       @options     = options
+      @max_length  = options[:max_length] || MAX_LENGTH
       @headers     = Headers.new
       @queue       = []
       @ready_state = 0

data/lib/websocket/driver/draft75.rb

@@ -11,7 +11,15 @@ module WebSocket
         'hixie-75'
       end
 
+      def close(reason = nil, code = nil)
+        return false if @ready_state == 3
+        @ready_state = 3
+        emit(:close, CloseEvent.new(nil, nil))
+        true
+      end
+
       def parse(buffer)
+        return if @ready_state > 1
         buffer = buffer.bytes if buffer.respond_to?(:bytes)
 
         buffer.each do |data|
@@ -28,8 +36,7 @@ module WebSocket
               @length = value + 128 * @length
 
               if @closing and @length.zero?
-                @ready_state = 3
-                emit(:close, CloseEvent.new(nil, nil))
+                return close
               elsif (0x80 & data) != 0x80
                 if @length.zero?
                   @stage = 0
@@ -49,6 +56,7 @@ module WebSocket
                   @stage = 0 if @skipped == @length
                 else
                   @buffer << data
+                  return close if @buffer.size > @max_length
                 end
               end
           end

data/lib/websocket/driver/hybi.rb

@@ -32,8 +32,6 @@ module WebSocket
       FRAGMENTED_OPCODES = OPCODES.values_at(:continuation, :text, :binary)
       OPENING_OPCODES    = OPCODES.values_at(:text, :binary)
 
-      MAX_LENGTH = 0x3fffffff
-
       ERRORS = {
         :normal_closure       => 1000,
         :going_away           => 1001,
@@ -54,12 +52,11 @@ module WebSocket
         super
         reset
 
-        @reader     = StreamReader.new
-        @stage      = 0
-        @masking    = options[:masking]
-        @protocols  = options[:protocols] || []
-        @protocols  = @protocols.strip.split(/\s*,\s*/) if String === @protocols
-        @max_length = options[:max_length] || MAX_LENGTH
+        @reader    = StreamReader.new
+        @stage     = 0
+        @masking   = options[:masking]
+        @protocols = options[:protocols] || []
+        @protocols = @protocols.strip.split(/\s*,\s*/) if String === @protocols
 
         @require_masking = options[:require_masking]
         @ping_callbacks  = {}
@@ -101,6 +98,9 @@ module WebSocket
                 emit_frame
                 @stage = 0
               end
+
+            else
+              buffer = nil
           end
         end
       end
@@ -222,6 +222,7 @@ module WebSocket
       def shutdown(code, reason)
         frame(reason, :close, code)
         @ready_state = 3
+        @stage = 5
         emit(:close, CloseEvent.new(code, reason))
       end
 
@@ -268,7 +269,8 @@ module WebSocket
 
         @length = (data & LENGTH)
 
-        if @length <= 125
+        if @length >= 0 and @length <= 125
+          return unless check_frame_length
           @stage = @masked ? 3 : 4
         else
           @length_size = (@length == 126) ? 2 : 8
@@ -283,13 +285,20 @@ module WebSocket
           return fail(:protocol_error, "Received control frame having too long payload: #{@length}")
         end
 
-        if @length > @max_length
-          return fail(:too_large, 'WebSocket frame length too large')
-        end
+        return unless check_frame_length
 
         @stage  = @masked ? 3 : 4
       end
 
+      def check_frame_length
+        if @buffer.size + @length > @max_length
+          fail(:too_large, 'WebSocket frame length too large')
+          false
+        else
+          true
+        end
+      end
+
       def emit_frame
         payload = @masked ? Mask.mask(@payload, @mask) : @payload
 

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.3.2
 platform: ruby
 authors:
 - James Coglan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   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'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rspec
   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: 
@@ -67,53 +60,52 @@ extensions:
 extra_rdoc_files:
 - README.md
 files:
-- README.md
 - CHANGELOG.md
-- ext/websocket_mask/websocket_mask.c
+- README.md
+- examples/tcp_server.rb
 - ext/websocket_mask/WebsocketMaskService.java
 - ext/websocket_mask/extconf.rb
-- examples/tcp_server.rb
-- lib/websocket/http/request.rb
-- lib/websocket/http/headers.rb
-- lib/websocket/http/response.rb
+- ext/websocket_mask/websocket_mask.c
 - lib/websocket/driver.rb
-- lib/websocket/http.rb
-- lib/websocket/driver/hybi/stream_reader.rb
-- lib/websocket/driver/utf8_match.rb
-- lib/websocket/driver/headers.rb
-- lib/websocket/driver/hybi.rb
-- lib/websocket/driver/server.rb
 - lib/websocket/driver/client.rb
 - lib/websocket/driver/draft75.rb
-- lib/websocket/driver/event_emitter.rb
 - lib/websocket/driver/draft76.rb
+- lib/websocket/driver/event_emitter.rb
+- lib/websocket/driver/headers.rb
+- lib/websocket/driver/hybi.rb
+- lib/websocket/driver/hybi/stream_reader.rb
+- lib/websocket/driver/server.rb
+- lib/websocket/driver/utf8_match.rb
+- lib/websocket/http.rb
+- lib/websocket/http/headers.rb
+- lib/websocket/http/request.rb
+- lib/websocket/http/response.rb
 homepage: http://github.com/faye/websocket-driver-ruby
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - README.md
-- --markup
+- "--markup"
 - markdown
 require_paths:
 - lib
 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: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: WebSocket protocol handler with pluggable I/O
 test_files: []