em-websocket 0.3.6 → 0.3.7

data/CHANGELOG.rdoc

@@ -1,5 +1,16 @@
 = Changelog
 
+== 0.3.7 / 2012-07-11
+
+- new features:
+  - Supports sending 1009 error code when incoming frame is too large to handle, and added associated exception class WSMessageTooBigError [Martyn Loughran]
+  - Supports overriding the maximum frame size by setting the max_frame_size accessor on the connection object (in bytes). Default unchanged at 10MB. [Martyn Loughran]
+
+- bug fixes:
+  - Fixes some encoding issues on Ruby 1.9 [Dingding Ye]
+  - Raises a HandshakeError if WS header is empty [Markus Fenske]
+  - Connection#send would mutate passed string to BINARY encoding. The fix still mutates the string by forcing the encoding back to UTF-8 before returning, but if the passed string was encoded as UTF-8 this is equivalent [Martyn Loughran]
+
 == 0.3.6 / 2011-12-23
 
 - new features:

data/lib/em-websocket/connection.rb

@@ -5,6 +5,8 @@ module EventMachine
     class Connection < EventMachine::Connection
       include Debugger
 
+      attr_writer :max_frame_size
+
       # define WebSocket callbacks
       def onopen(&blk);     @onopen = blk;    end
       def onclose(&blk);    @onclose = blk;   end
@@ -75,10 +77,10 @@ module EventMachine
         trigger_on_error(e)
         # Errors during the handshake require the connection to be aborted
         abort
-      rescue WebSocketError => e
+      rescue WSProtocolError => e
         debug [:error, e]
         trigger_on_error(e)
-        close_websocket_private(1002) # 1002 indicates a protocol error
+        close_websocket_private(e.code)
       rescue => e
         debug [:error, e]
         # These are application errors - raise unless onerror defined
@@ -127,16 +129,26 @@ module EventMachine
         close_connection_after_writing
       end
 
+      # Cache encodings since it's moderately expensive to look them up each time
+      ENCODING_SUPPORTED = "string".respond_to?(:force_encoding)
+      UTF8 = Encoding.find("UTF-8") if ENCODING_SUPPORTED
+      BINARY = Encoding.find("BINARY") if ENCODING_SUPPORTED
+
+      # Send a WebSocket text frame.
+      #
+      # A WebSocketError may be raised if the connection is in an opening or a
+      # closing state, or if the passed in data is not valid UTF-8
+      #
       def send(data)
         # If we're using Ruby 1.9, be pedantic about encodings
-        if data.respond_to?(:force_encoding)
+        if ENCODING_SUPPORTED
           # Also accept ascii only data in other encodings for convenience
-          unless (data.encoding == Encoding.find("UTF-8") && data.valid_encoding?) || data.ascii_only?
+          unless (data.encoding == UTF8 && data.valid_encoding?) || data.ascii_only?
             raise WebSocketError, "Data sent to WebSocket must be valid UTF-8 but was #{data.encoding} (valid: #{data.valid_encoding?})"
           end
           # This labels the encoding as binary so that it can be combined with
           # the BINARY framing
-          data.force_encoding("BINARY")
+          data.force_encoding(BINARY)
         else
           # TODO: Check that data is valid UTF-8
         end
@@ -146,6 +158,10 @@ module EventMachine
         else
           raise WebSocketError, "Cannot send data before onopen callback"
         end
+
+        # Revert data back to the original encoding (which we assume is UTF-8)
+        # Doing this to avoid duping the string - there may be a better way
+        data.force_encoding(UTF8)
       end
 
       # Send a ping to the client. The client must respond with a pong.
@@ -193,6 +209,18 @@ module EventMachine
         @handler ? @handler.state : :handshake
       end
 
+      # Returns the maximum frame size which this connection is configured to
+      # accept. This can be set globally or on a per connection basis, and
+      # defaults to a value of 10MB if not set.
+      #
+      # The behaviour when a too large frame is received varies by protocol,
+      # but in the newest protocols the connection will be closed with the
+      # correct close code (1009) immediately after receiving the frame header
+      #
+      def max_frame_size
+        @max_frame_size || WebSocket.max_frame_size
+      end
+
       private
 
       # As definited in draft 06 7.2.2, some failures require that the server

data/lib/em-websocket/framing03.rb

@@ -3,11 +3,6 @@
 module EventMachine
   module WebSocket
     module Framing03
-
-      # Set the max frame lenth to very high value (10MB) until there is a
-      # limit specified in the spec to protect against malicious attacks
-      MAXIMUM_FRAME_LENGTH = 10 * 1024 * 1024
-
       def initialize_framing
         @data = ''
         @application_data_buffer = '' # Used for MORE frames
@@ -57,9 +52,8 @@ module EventMachine
             length
           end
 
-          # Addition to the spec to protect against malicious requests
-          if payload_length > MAXIMUM_FRAME_LENGTH
-            raise DataError, "Frame length too long (#{payload_length} bytes)"
+          if payload_length > @connection.max_frame_size
+            raise WSMessageTooBigError, "Frame length too long (#{payload_length} bytes)"
           end
 
           # Check buffer size
@@ -78,7 +72,7 @@ module EventMachine
           frame_type = opcode_to_type(opcode)
 
           if frame_type == :continuation && !@frame_type
-            raise WebSocketError, 'Continuation frame not expected'
+            raise WSProtocolError, 'Continuation frame not expected'
           end
 
           if more
@@ -156,7 +150,7 @@ module EventMachine
       end
 
       def opcode_to_type(opcode)
-        FRAME_TYPES_INVERSE[opcode] || raise(DataError, "Unknown opcode")
+        FRAME_TYPES_INVERSE[opcode] || raise(WSProtocolError, "Unknown opcode")
       end
 
       def data_frame?(type)

data/lib/em-websocket/framing05.rb

@@ -3,11 +3,6 @@
 module EventMachine
   module WebSocket
     module Framing05
-      
-      # Set the max frame lenth to very high value (10MB) until there is a
-      # limit specified in the spec to protect against malicious attacks
-      MAXIMUM_FRAME_LENGTH = 10 * 1024 * 1024
-      
       def initialize_framing
         @data = MaskedString.new
         @application_data_buffer = '' # Used for MORE frames
@@ -60,9 +55,8 @@ module EventMachine
             length
           end
 
-          # Addition to the spec to protect against malicious requests
-          if payload_length > MAXIMUM_FRAME_LENGTH
-            raise DataError, "Frame length too long (#{payload_length} bytes)"
+          if payload_length > @connection.max_frame_size
+            raise WSMessageTooBigError, "Frame length too long (#{payload_length} bytes)"
           end
 
           # Check buffer size
@@ -83,7 +77,7 @@ module EventMachine
           frame_type = opcode_to_type(opcode)
 
           if frame_type == :continuation && !@frame_type
-            raise WebSocketError, 'Continuation frame not expected'
+            raise WSProtocolError, 'Continuation frame not expected'
           end
 
           if !fin
@@ -157,7 +151,7 @@ module EventMachine
       end
 
       def opcode_to_type(opcode)
-        FRAME_TYPES_INVERSE[opcode] || raise(DataError, "Unknown opcode")
+        FRAME_TYPES_INVERSE[opcode] || raise(WSProtocolError, "Unknown opcode")
       end
 
       def data_frame?(type)

data/lib/em-websocket/framing07.rb

@@ -59,6 +59,10 @@ module EventMachine
           frame_length = pointer + payload_length
           frame_length += 4 if mask
 
+          if frame_length > @connection.max_frame_size
+            raise WSMessageTooBigError, "Frame length too long (#{frame_length} bytes)"
+          end
+
           # Check buffer size
           if @data.getbyte(frame_length - 1) == nil
             debug [:buffer_incomplete, @data]
@@ -83,7 +87,7 @@ module EventMachine
           frame_type = opcode_to_type(opcode)
 
           if frame_type == :continuation && !@frame_type
-            raise WebSocketError, 'Continuation frame not expected'
+            raise WSProtocolError, 'Continuation frame not expected'
           end
 
           if !fin
@@ -158,7 +162,7 @@ module EventMachine
       end
 
       def opcode_to_type(opcode)
-        FRAME_TYPES_INVERSE[opcode] || raise(DataError, "Unknown opcode")
+        FRAME_TYPES_INVERSE[opcode] || raise(WSProtocolError, "Unknown opcode")
       end
 
       def data_frame?(type)

data/lib/em-websocket/framing76.rb

@@ -3,11 +3,6 @@
 module EventMachine
   module WebSocket
     module Framing76
-      
-      # Set the max frame lenth to very high value (10MB) until there is a
-      # limit specified in the spec to protect against malicious attacks
-      MAXIMUM_FRAME_LENGTH = 10 * 1024 * 1024
-      
       def initialize_framing
         @data = ''
       end
@@ -40,9 +35,8 @@ module EventMachine
               break unless (b & 0x80) == 0x80
             end
 
-            # Addition to the spec to protect against malicious requests
-            if length > MAXIMUM_FRAME_LENGTH
-              raise DataError, "Frame length too long (#{length} bytes)"
+            if length > @connection.max_frame_size
+              raise WSMessageTooBigError, "Frame length too long (#{length} bytes)"
             end
 
             if @data.getbyte(pointer+length-1) == nil
@@ -69,12 +63,12 @@ module EventMachine
 
             if @data.getbyte(0) != 0x00
               # Close the connection since this buffer can never match
-              raise DataError, "Invalid frame received"
+              raise WSProtocolError, "Invalid frame received"
             end
 
             # Addition to the spec to protect against malicious requests
-            if @data.size > MAXIMUM_FRAME_LENGTH
-              raise DataError, "Frame length too long (#{@data.size} bytes)"
+            if @data.size > @connection.max_frame_size
+              raise WSMessageTooBigError, "Frame length too long (#{@data.size} bytes)"
             end
 
             # Optimization to avoid calling slice! unnecessarily

data/lib/em-websocket/handler_factory.rb

@@ -15,6 +15,8 @@ module EventMachine
 
         lines = header.split("\r\n")
 
+        raise HandshakeError, "Empty HTTP header" unless lines.size > 0
+
         # extract request path
         first_line = lines.shift.match(PATH)
         raise HandshakeError, "Invalid HTTP header" unless first_line
@@ -99,7 +101,7 @@ module EventMachine
           Handler13.new(connection, request, debug)
         else
           # According to spec should abort the connection
-          raise WebSocketError, "Protocol version #{version} not supported"
+          raise HandshakeError, "Protocol version #{version} not supported"
         end
       end
     end

data/lib/em-websocket/masking04.rb

@@ -29,7 +29,7 @@ module EventMachine
       end
 
       def getbytes(start_index, count)
-        data = ''
+        data = ''.force_encoding('ASCII-8BIT')
         count.times do |i|
           data << getbyte(start_index + i)
         end

data/lib/em-websocket/message_processor_06.rb

@@ -12,7 +12,7 @@ module EventMachine
             nil
           when 1
             # Illegal close frame
-            raise DataError, "Close frames with a body must contain a 2 byte status code"
+            raise WSProtocolError, "Close frames with a body must contain a 2 byte status code"
           else
             application_data.slice!(0, 2).unpack('n').first
           end
@@ -20,8 +20,8 @@ module EventMachine
           debug [:close_frame_received, status_code, application_data]
           
           if @state == :closing
-            # We can close connection immediately since there is no more data
-            # is allowed to be sent or received on this connection
+            # We can close connection immediately since no more data may be
+            # sent or received on this connection
             @connection.close_connection
             @state = :closed
           else

data/lib/em-websocket/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   module Websocket
-    VERSION = "0.3.6"
+    VERSION = "0.3.7"
   end
 end

data/lib/em-websocket/websocket.rb

@@ -1,8 +1,24 @@
 module EventMachine
   module WebSocket
+    # All errors raised by em-websocket should descend from this class
+    #
     class WebSocketError < RuntimeError; end
+
+    # Used for errors that occur during WebSocket handshake
+    #
     class HandshakeError < WebSocketError; end
-    class DataError < WebSocketError; end
+
+    # Used for errors which should cause the connection to close.
+    # See RFC6455 §7.4.1 for a full description of meanings
+    #
+    class WSProtocolError < WebSocketError
+      def code; 1002; end
+    end
+
+    # 1009: Message too big to process
+    class WSMessageTooBigError < WSProtocolError
+      def code; 1009; end
+    end
 
     def self.start(options, &blk)
       EM.epoll
@@ -22,5 +38,10 @@ module EventMachine
       puts "Terminating WebSocket Server"
       EventMachine.stop
     end
+
+    class << self
+      attr_accessor :max_frame_size
+    end
+    @max_frame_size = 10 * 1024 * 1024 # 10MB
   end
 end

data/spec/helper.rb

@@ -107,6 +107,7 @@ class Draft75WebSocketClient
     @ws.errback { @onerror.call if @onerror }
     @ws.callback { @onopen.call if @onopen }
     @ws.stream { |msg| @onmessage.call(msg) if @onmessage }
+    @ws.disconnect { @onclose.call if @onclose }
   end
 
   def send(message)

data/spec/integration/common_spec.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-# These tests are not specifi to any particular draft of the specification
+# These tests are not specific to any particular draft of the specification
 # 
 describe "WebSocket server" do
   include EM::SpecHelper

data/spec/integration/draft76_spec.rb

@@ -140,7 +140,7 @@ describe "WebSocket server draft76" do
     em {
       EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |server|
         server.onerror { |error|
-          error.should be_an_instance_of EM::WebSocket::DataError
+          error.should be_an_instance_of EM::WebSocket::WSMessageTooBigError
           error.message.should == "Frame length too long (1180591620717411303296 bytes)"
           done
         }
@@ -164,7 +164,7 @@ describe "WebSocket server draft76" do
     em {
       EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |server|
         server.onerror { |error|
-          error.should be_an_instance_of EM::WebSocket::DataError
+          error.should be_an_instance_of EM::WebSocket::WSProtocolError
           error.message.should == "Invalid frame received"
           done
         }

data/spec/integration/shared_examples.rb

@@ -1,5 +1,7 @@
 # encoding: UTF-8
 
+# These tests are run against all draft versions
+#
 shared_examples_for "a websocket server" do
   it "should call onerror if an application error raised in onopen" do
     em {
@@ -62,6 +64,41 @@ shared_examples_for "a websocket server" do
     }
   end
 
+  it "should close the connection when a too long frame is sent" do
+    em {
+      start_server { |server|
+        server.max_frame_size = 20
+
+        server.onerror { |e|
+          # 3: Error should be reported to server
+          e.class.should == EventMachine::WebSocket::WSMessageTooBigError
+          e.message.should =~ /Frame length too long/
+        }
+      }
+
+      start_client { |client|
+        client.onopen {
+          EM.next_tick {
+            client.send("This message is longer than 20 characters")
+          }
+
+        }
+
+        client.onmessage { |msg|
+          # 4: This is actually the close message. Really need to use a real
+          # WebSocket client in these tests...
+          done
+        }
+
+        client.onclose {
+          # 4: Drafts 75 & 76 don't send a close message, they just close the
+          # connection
+          done
+        }
+      }
+    }
+  end
+
   # Only run these tests on ruby 1.9
   if "a".respond_to?(:force_encoding)
     it "should raise error if you try to send non utf8 text data to ws" do
@@ -87,5 +124,23 @@ shared_examples_for "a websocket server" do
         start_client { }
       }
     end
+
+    it "should not change the encoding of strings sent to send [antiregression]" do
+      em {
+        start_server { |server|
+          server.onopen {
+            s = "example string"
+            s.force_encoding("UTF-8")
+
+            server.send(s)
+
+            s.encoding.should == Encoding.find("UTF-8")
+            done
+          }
+        }
+
+        start_client { }
+      }
+    end
   end
 end

data/spec/unit/framing_spec.rb

@@ -4,6 +4,13 @@ describe EM::WebSocket::Framing03 do
   class FramingContainer
     include EM::WebSocket::Framing03
     
+    def initialize
+      @connection = Object.new
+      def @connection.max_frame_size
+        1000000
+      end
+    end
+
     def <<(data)
       @data << data
       process_data(data)
@@ -122,6 +129,13 @@ describe EM::WebSocket::Framing04 do
   class FramingContainer04
     include EM::WebSocket::Framing04
 
+    def initialize
+      @connection = Object.new
+      def @connection.max_frame_size
+        1000000
+      end
+    end
+
     def <<(data)
       @data << data
       process_data(data)
@@ -184,6 +198,13 @@ describe EM::WebSocket::Framing07 do
   class FramingContainer07
     include EM::WebSocket::Framing07
 
+    def initialize
+      @connection = Object.new
+      def @connection.max_frame_size
+        1000000
+      end
+    end
+
     def <<(data)
       @data << data
       process_data(data)
@@ -240,11 +261,11 @@ describe EM::WebSocket::Framing07 do
   end
 
   describe "other tests" do
-    it "should raise a DataError if an invalid frame type is requested" do
+    it "should raise a WSProtocolError if an invalid frame type is requested" do
       lambda {
         # Opcode 3 is not supported by this draft
         @f << "\x83\x05Hello"
-      }.should raise_error(EventMachine::WebSocket::DataError, "Unknown opcode")
+      }.should raise_error(EventMachine::WebSocket::WSProtocolError, "Unknown opcode")
     end
 
     it "should accept a fragmented unmasked text message in 3 frames" do

data/spec/unit/handler_spec.rb

@@ -138,6 +138,13 @@ describe "EventMachine::WebSocket::Handler" do
     }.should raise_error(EM::WebSocket::HandshakeError, 'Invalid Key "12998 5 Y3 1.P00"')
   end
 
+  it "should raise error if the HTTP header is empty" do
+    connection = Object.new
+    lambda {
+      EM::WebSocket::HandlerFactory.build(connection, "\r\n\r\nfoobar", false)
+    }.should raise_error(EM::WebSocket::HandshakeError, "Empty HTTP header")
+  end
+
   it "should leave request with incomplete header" do
     data = format_request(@request)
     # Sends only half of the request

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-websocket
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-23 00:00:00.000000000 Z
+date: 2012-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70364656209880 !ruby/object:Gem::Requirement
+  requirement: &70199777824640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.12.9
   type: :runtime
   prerelease: false
-  version_requirements: *70364656209880
+  version_requirements: *70199777824640
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70364656231520 !ruby/object:Gem::Requirement
+  requirement: &70199777824040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,21 +33,21 @@ dependencies:
         version: 2.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70364656231520
+  version_requirements: *70199777824040
 - !ruby/object:Gem::Dependency
   name: em-spec
-  requirement: &70364656231060 !ruby/object:Gem::Requirement
+  requirement: &70199777823420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
   type: :development
   prerelease: false
-  version_requirements: *70364656231060
+  version_requirements: *70199777823420
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70364656230580 !ruby/object:Gem::Requirement
+  requirement: &70199777822580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 0.12.10
   type: :development
   prerelease: false
-  version_requirements: *70364656230580
+  version_requirements: *70199777822580
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70364656230100 !ruby/object:Gem::Requirement
+  requirement: &70199777821520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,21 +66,21 @@ dependencies:
         version: 0.2.6
   type: :development
   prerelease: false
-  version_requirements: *70364656230100
+  version_requirements: *70199777821520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70364656229640 !ruby/object:Gem::Requirement
+  requirement: &70199777818940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70364656229640
+  version_requirements: *70199777818940
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70364656229260 !ruby/object:Gem::Requirement
+  requirement: &70199777817860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70364656229260
+  version_requirements: *70199777817860
 description: EventMachine based WebSocket server
 email:
 - ilya@igvita.com
@@ -191,3 +191,4 @@ test_files:
 - spec/unit/framing_spec.rb
 - spec/unit/handler_spec.rb
 - spec/unit/masking_spec.rb
+has_rdoc: