websocket-driver 0.7.5 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 046c514660d2c0dab2cf42bce8314a17e713909377a5da470beaeadf666ff28e
-  data.tar.gz: 9830c412394044d102dd6f313346721076ef0f97284d6182aeb06862e1f427b2
+  metadata.gz: bf509f60cf8b74b4a6e2dd7cf7038b53817271cfc2985d2234037946543e9fed
+  data.tar.gz: 3f4433596095d12a4f70b4477c20f0d6f4bfe96ef18ca711fee0996815a991a8
 SHA512:
-  metadata.gz: cea4027f342f51a688c8004a92ca29b68af9a9395b5e7f8d2462b8742067862718d23f4be9ca6162f761774490e4cdf33111bb746f9221d5acace6546a749b35
-  data.tar.gz: d124aa6acf1cbfa498b44d02d6aa659c99e97e177441e8cbd43958db38c6cf03d703d26ae73998a09719c0612f538554049d58b58aa8cc8ab5f0bb458e27c988
+  metadata.gz: a558a93b903403cc48e0683ce3247c02a613f9e4b19ee3bc476ccc621cdf3a23160a4eb2615cc259fe227a74de54f3728d11b6732fa2e88a6d1d672ba96240d4
+  data.tar.gz: 9f591c43f2f34de6444069d3c34ec7b5b4813cc9c2e76203f8d1d48942f6b1712c1ad2847887f47759012d9c0ac95a90f82bb144d0311fb94e4a9d9ce0eae10e

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+### 0.8.2 / 2026-06-23
+
+- Gracefully handle malformed `Host` headers in the `Server` driver
+
+### 0.8.1 / 2026-06-04
+
+- Close a draft-75/76 connection if a length header grows to exceed the
+  configured max length
+- Fail the connection if a message is larger than the configured max length
+  after extension processing
+- Limit the total HTTP request line and headers size to 32K
+
+### 0.8.0 / 2025-05-25
+
+- Emit binary message as a string with `Encoding::BINARY` instead of an array
+- Add the option `:binary_data_format` to force the previous behaviour
+
+### 0.7.7 / 2025-01-04
+
+- Add `base64` gem to the dependencies to support Ruby 3.4
+
+### 0.7.6 / 2023-07-25
+
+- Fix handling of default ports in `Host` headers on Ruby 3.1+
+
 ### 0.7.5 / 2021-06-12
 
 - Do not change the encoding of strings passed to `Driver#text`

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2010-2021 James Coglan
+Copyright 2010-2026 James Coglan
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 this file except in compliance with the License. You may obtain a copy of the

data/README.md

@@ -275,6 +275,10 @@ keys:
 - `: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.
+- `:binary_data_format` - in older versions of this library, binary messages
+  were represented as arrays of bytes, whereas they're now represented as
+  strings with `Encoding::BINARY` for performance reasons. Set this option to
+  `:array` to restore the old behaviour.
 
 All drivers respond to the following API methods, but some of them are no-ops
 depending on whether the client supports the behaviour.
@@ -290,8 +294,8 @@ Adds a callback block to execute when the socket becomes open.
 #### `driver.on :message, -> (event) {}`
 
 Adds a callback block to execute when a message is received. `event` will have a
-`data` attribute containing either a string in the case of a text message or an
-array of integers in the case of a binary message.
+`data` attribute whose value is a string with the encoding `Encoding::UTF_8` for
+text message, and `Encoding::BINARY` for binary message.
 
 #### `driver.on :error, -> (event) {}`
 
@@ -346,11 +350,12 @@ Sends a text message over the socket. If the socket handshake is not yet
 complete, the message will be queued until it is. Returns `true` if the message
 was sent or queued, and `false` if the socket can no longer send messages.
 
-#### `driver.binary(array)`
+#### `driver.binary(buffer)`
 
-Takes an array of byte-sized integers and sends them as a binary message. Will
-queue and return `true` or `false` the same way as the `text` method. It will
-also return `false` if the driver does not support binary messages.
+Takes either a string with encoding `Encoding::BINARY`, or an array of
+byte-sized integers, and sends it as a binary message. Will queue and return
+`true` or `false` the same way as the `text` method. It will also return `false`
+if the driver does not support binary messages.
 
 #### `driver.ping(string = '', &callback)`
 

data/lib/websocket/driver/client.rb

@@ -23,11 +23,10 @@ module WebSocket
           raise URIError, "#{ socket.url } is not a valid WebSocket URL"
         end
 
-        host      = uri.host + (uri.port ? ":#{ uri.port }" : '')
         path      = (uri.path == '') ? '/' : uri.path
         @pathname = path + (uri.query ? '?' + uri.query : '')
 
-        @headers['Host']                  = host
+        @headers['Host']                  = Driver.host_header(uri)
         @headers['Upgrade']               = 'websocket'
         @headers['Connection']            = 'Upgrade'
         @headers['Sec-WebSocket-Key']     = @key

data/lib/websocket/driver/draft75.rb

@@ -41,6 +41,7 @@ module WebSocket
 
             when 1 then
               @length = (octet & 0x7F) + 128 * @length
+              return close if @length > @max_length
 
               if @closing and @length.zero?
                 return close

data/lib/websocket/driver/hybi.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 module WebSocket
   class Driver
 
@@ -161,11 +163,13 @@ module WebSocket
         message = Message.new
         frame   = Frame.new
 
-        message.rsv1   = message.rsv2 = message.rsv3 = false
-        message.opcode = OPCODES[type || (String === buffer ? :text : :binary)]
+        is_binary = (Array === buffer or buffer.encoding == Encoding::BINARY)
+        payload   = Driver.encode(buffer, is_binary ? nil : Encoding::UTF_8)
+        payload   = [code, payload].pack('S>a*') if code
+        type    ||= is_binary ? :binary : :text
 
-        payload = Driver.encode(buffer)
-        payload = [code, payload].pack('S>a*') if code
+        message.rsv1 = message.rsv2 = message.rsv3 = false
+        message.opcode = OPCODES[type]
         message.data = payload
 
         if MESSAGE_OPCODES.include?(message.opcode)
@@ -396,12 +400,20 @@ module WebSocket
 
         payload = message.data
 
+        if payload.bytesize > @max_length
+          return fail(:too_large, 'WebSocket frame length too large')
+        end
+
         case message.opcode
           when OPCODES[:text] then
             payload = Driver.encode(payload, Encoding::UTF_8)
             payload = nil unless payload.valid_encoding?
           when OPCODES[:binary]
-            payload = payload.bytes.to_a
+            if @binary_data_format == :array
+              payload = payload.bytes.to_a
+            else
+              payload = Driver.encode(payload, Encoding::BINARY)
+            end
         end
 
         if payload

data/lib/websocket/driver/proxy.rb

@@ -4,8 +4,6 @@ module WebSocket
     class Proxy
       include EventEmitter
 
-      PORTS = { 'ws' => 80, 'wss' => 443 }
-
       attr_reader :status, :headers
 
       def initialize(client, origin, options)
@@ -20,7 +18,7 @@ module WebSocket
         @state   = 0
 
         @headers = Headers.new
-        @headers['Host'] = @origin.host + (@origin.port ? ":#{ @origin.port }" : '')
+        @headers['Host'] = Driver.host_header(@origin)
         @headers['Connection'] = 'keep-alive'
         @headers['Proxy-Connection'] = 'keep-alive'
 

data/lib/websocket/driver.rb

@@ -42,6 +42,7 @@ module WebSocket
     end
 
     MAX_LENGTH = 0x3ffffff
+    PORTS      = { 'ws' => 80, 'wss' => 443 }
     STATES     = [:connecting, :open, :closing, :closed]
 
     ConnectEvent = Struct.new(nil)
@@ -70,7 +71,7 @@ module WebSocket
 
     def initialize(socket, options = {})
       super()
-      Driver.validate_options(options, [:max_length, :masking, :require_masking, :protocols])
+      Driver.validate_options(options, [:max_length, :masking, :require_masking, :protocols, :binary_data_format])
 
       @socket      = socket
       @reader      = StreamReader.new
@@ -79,6 +80,8 @@ module WebSocket
       @headers     = Headers.new
       @queue       = []
       @ready_state = 0
+
+      @binary_data_format = options[:binary_data_format] || :string
     end
 
     def state
@@ -196,17 +199,26 @@ module WebSocket
 
     def self.encode(data, encoding = nil)
       if Array === data
+        data = data.pack('C*')
         encoding ||= Encoding::BINARY
-        return data.pack('C*').force_encoding(encoding)
       end
 
-      encoding ||= Encoding::UTF_8
+      return data if encoding.nil? or data.encoding == encoding
 
-      return data if data.encoding == encoding
-      return data.encode(encoding) unless data.encoding == Encoding::BINARY
+      if data.encoding == Encoding::BINARY
+        data = data.dup if data.frozen?
+        data.force_encoding(encoding)
+      else
+        data.encode(encoding)
+      end
+    end
 
-      data = data.dup if data.frozen?
-      data.force_encoding(encoding)
+    def self.host_header(uri)
+      host = uri.host
+      if uri.port and uri.port != PORTS[uri.scheme]
+        host += ":#{uri.port}"
+      end
+      host
     end
 
     def self.validate_options(options, valid_keys)
@@ -215,6 +227,12 @@ module WebSocket
           raise ConfigurationError, "Unrecognized option: #{ key.inspect }"
         end
       end
+
+      if options[:binary_data_format]
+        unless [:array, :string].include?(options[:binary_data_format])
+          raise ConfigurationError, "Invalid :binary_data_format: #{options[:binary_data_format].inspect}"
+        end
+      end
     end
 
     def self.websocket?(env)

data/lib/websocket/http/headers.rb

@@ -2,7 +2,7 @@ module WebSocket
   module HTTP
 
     module Headers
-      MAX_LINE_LENGTH = 4096
+      MAX_REQUEST_SIZE = 32768
       CR = 0x0D
       LF = 0x0A
 
@@ -38,6 +38,7 @@ module WebSocket
       attr_reader :headers
 
       def initialize
+        @size    = 0
         @buffer  = []
         @env     = {}
         @headers = {}
@@ -54,6 +55,9 @@ module WebSocket
 
       def parse(chunk)
         chunk.each_byte do |octet|
+          @size += 1
+          return error if @size > MAX_REQUEST_SIZE
+
           if octet == LF and @stage < 2
             @buffer.pop if @buffer.last == CR
             if @buffer.empty?
@@ -71,9 +75,8 @@ module WebSocket
               end
             end
             @buffer = []
-          else
-            @buffer << octet if @stage >= 0
-            error if @stage < 2 and @buffer.size > MAX_LINE_LENGTH
+          elsif @stage >= 0
+            @buffer << octet
           end
         end
         @env['rack.input'] = StringIO.new(string_buffer)

data/lib/websocket/http/request.rb

@@ -33,11 +33,18 @@ module WebSocket
           rack_name = "HTTP_#{ rack_name }" unless RESERVED_HEADERS.include?(name)
           @env[rack_name] = value
         end
-        if host = @env['HTTP_HOST']
-          uri = URI.parse("http://#{ host }")
-          @env['SERVER_NAME'] = uri.host
-          @env['SERVER_PORT'] = uri.port.to_s
-        end
+
+        set_server_vars
+      end
+
+      def set_server_vars
+        return unless host = @env['HTTP_HOST']
+
+        uri = URI.parse("http://#{ host }")
+        @env['SERVER_NAME'] = uri.host
+        @env['SERVER_PORT'] = uri.port.to_s
+      rescue URI::InvalidURIError
+        error
       end
     end
 

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.2
 platform: ruby
 authors:
 - James Coglan
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: websocket-extensions
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: jcoglan@gmail.com
 executables: []
 extensions:
@@ -115,8 +127,8 @@ files:
 homepage: https://github.com/faye/websocket-driver-ruby
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/faye/websocket-driver-ruby/blob/main/CHANGELOG.md
 rdoc_options:
 - "--main"
 - README.md
@@ -135,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: WebSocket protocol handler with pluggable I/O
 test_files: []