websocket-driver 0.8.1-java → 0.9.0-java
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +3 -0
- data/lib/websocket/driver/draft75.rb +14 -11
- data/lib/websocket/driver/draft76.rb +19 -20
- data/lib/websocket/driver/hybi.rb +5 -4
- data/lib/websocket/driver.rb +8 -15
- data/lib/websocket/http/request.rb +12 -5
- data/lib/websocket_mask.jar +0 -0
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7ceebe1ce43b4929db080c5ea16ce9ea2ea9a120b51e6d9d92545303a30ac611
|
|
4
|
+
data.tar.gz: f5d2605c8fb370a3f56358b4797b88c6af213821b6764024c2634067c76a6f9d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 748d319448b1ffc72f286a410885357d5458922a4ee2831a63937fc1e15729309f0de47134fc864a90f7f6c6aa104668275e4922c91e2f11767f3a3ef7da40d7
|
|
7
|
+
data.tar.gz: 54e05d487e1a70bc70971d66f88ce8bc4328bcdafae3fb63988c457fcf7d25ff16737a9078fe570df691e9e908d31d95d1242b5ae0267287d1b7acb6b10ab1e6
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,17 @@
|
|
|
1
|
+
### 0.9.0 / 2026-11-16
|
|
2
|
+
|
|
3
|
+
- Add `allow_drafts` option to explicitly enable support for `draft75` and
|
|
4
|
+
`draft76` protocols; these are now disabled by default
|
|
5
|
+
- Forward the `max_length` option to any registered extensions
|
|
6
|
+
- Fix bug in `draft75` parser that could cause message corruption or crashes if
|
|
7
|
+
the byte `0xFF` appears in a byte stream following a length prefix
|
|
8
|
+
- Correctly handle cases where the `Sec-WebSocket-Key1` or `Sec-WebSocket-Key2`
|
|
9
|
+
header produces an invalid value
|
|
10
|
+
|
|
11
|
+
### 0.8.2 / 2026-06-23
|
|
12
|
+
|
|
13
|
+
- Gracefully handle malformed `Host` headers in the `Server` driver
|
|
14
|
+
|
|
1
15
|
### 0.8.1 / 2026-06-04
|
|
2
16
|
|
|
3
17
|
- Close a draft-75/76 connection if a length header grows to exceed the
|
data/README.md
CHANGED
|
@@ -279,6 +279,9 @@ keys:
|
|
|
279
279
|
were represented as arrays of bytes, whereas they're now represented as
|
|
280
280
|
strings with `Encoding::BINARY` for performance reasons. Set this option to
|
|
281
281
|
`:array` to restore the old behaviour.
|
|
282
|
+
- `:allow_drafts` - if set to `true`, the driver will accept requests from
|
|
283
|
+
clients using long-outdated draft versions of the WebSocket protocol. For
|
|
284
|
+
security reasons, this option is turned off by default.
|
|
282
285
|
|
|
283
286
|
All drivers respond to the following API methods, but some of them are no-ops
|
|
284
287
|
depending on whether the client supports the behaviour.
|
|
@@ -43,9 +43,9 @@ module WebSocket
|
|
|
43
43
|
@length = (octet & 0x7F) + 128 * @length
|
|
44
44
|
return close if @length > @max_length
|
|
45
45
|
|
|
46
|
-
if @closing and @length.zero?
|
|
47
|
-
|
|
48
|
-
|
|
46
|
+
return close if @closing and @length.zero?
|
|
47
|
+
|
|
48
|
+
if (octet & 0x80) != 0x80
|
|
49
49
|
if @length.zero?
|
|
50
50
|
@stage = 0
|
|
51
51
|
else
|
|
@@ -55,17 +55,20 @@ module WebSocket
|
|
|
55
55
|
end
|
|
56
56
|
|
|
57
57
|
when 2 then
|
|
58
|
+
@skipped += 1
|
|
59
|
+
if @skipped == @length
|
|
60
|
+
@length = nil
|
|
61
|
+
@skipped = nil
|
|
62
|
+
@stage = 0
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
when 3 then
|
|
58
66
|
if octet == 0xFF
|
|
59
67
|
@stage = 0
|
|
60
68
|
emit(:message, MessageEvent.new(Driver.encode(@buffer, Encoding::UTF_8)))
|
|
61
69
|
else
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
@stage = 0 if @skipped == @length
|
|
65
|
-
else
|
|
66
|
-
@buffer << octet
|
|
67
|
-
return close if @buffer.size > @max_length
|
|
68
|
-
end
|
|
70
|
+
@buffer << octet
|
|
71
|
+
return close if @buffer.size > @max_length
|
|
69
72
|
end
|
|
70
73
|
end
|
|
71
74
|
end
|
|
@@ -94,7 +97,7 @@ module WebSocket
|
|
|
94
97
|
@length = nil
|
|
95
98
|
@skipped = nil
|
|
96
99
|
@buffer = []
|
|
97
|
-
@stage =
|
|
100
|
+
@stage = 3
|
|
98
101
|
end
|
|
99
102
|
end
|
|
100
103
|
end
|
|
@@ -39,24 +39,14 @@ module WebSocket
|
|
|
39
39
|
private
|
|
40
40
|
|
|
41
41
|
def handshake_response
|
|
42
|
-
env
|
|
43
|
-
key1
|
|
44
|
-
key2
|
|
42
|
+
env = @socket.env
|
|
43
|
+
key1 = env['HTTP_SEC_WEBSOCKET_KEY1']
|
|
44
|
+
key2 = env['HTTP_SEC_WEBSOCKET_KEY2']
|
|
45
45
|
|
|
46
46
|
raise ProtocolError.new('Missing required header: Sec-WebSocket-Key1') unless key1
|
|
47
47
|
raise ProtocolError.new('Missing required header: Sec-WebSocket-Key2') unless key2
|
|
48
48
|
|
|
49
|
-
|
|
50
|
-
spaces1 = spaces_in_key(key1)
|
|
51
|
-
|
|
52
|
-
number2 = number_from_key(key2)
|
|
53
|
-
spaces2 = spaces_in_key(key2)
|
|
54
|
-
|
|
55
|
-
if number1 % spaces1 != 0 or number2 % spaces2 != 0
|
|
56
|
-
raise ProtocolError.new('Client sent invalid Sec-WebSocket-Key headers')
|
|
57
|
-
end
|
|
58
|
-
|
|
59
|
-
@key_values = [number1 / spaces1, number2 / spaces2]
|
|
49
|
+
@key_values = [get_key_value(key1), get_key_value(key2)]
|
|
60
50
|
|
|
61
51
|
start = 'HTTP/1.1 101 WebSocket Protocol Handshake'
|
|
62
52
|
headers = [start, @headers.to_s, '']
|
|
@@ -85,13 +75,22 @@ module WebSocket
|
|
|
85
75
|
@stage = 1
|
|
86
76
|
end
|
|
87
77
|
|
|
88
|
-
def
|
|
89
|
-
|
|
90
|
-
number == '' ?
|
|
91
|
-
|
|
78
|
+
def get_key_value(key)
|
|
79
|
+
digits = key.scan(/[0-9]/).join('')
|
|
80
|
+
number = (digits == '') ? 0 : digits.to_i(10)
|
|
81
|
+
spaces = key.scan(/ /).size
|
|
92
82
|
|
|
93
|
-
|
|
94
|
-
|
|
83
|
+
if number == 0 or spaces == 0 or number % spaces != 0
|
|
84
|
+
raise ProtocolError.new('Client sent invalid Sec-WebSocket-Key headers')
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
div = number / spaces
|
|
88
|
+
|
|
89
|
+
if div <= 0xffffffff
|
|
90
|
+
div
|
|
91
|
+
else
|
|
92
|
+
raise ProtocolError.new('Client sent invalid Sec-WebSocket-Key headers')
|
|
93
|
+
end
|
|
95
94
|
end
|
|
96
95
|
end
|
|
97
96
|
|
|
@@ -59,7 +59,7 @@ module WebSocket
|
|
|
59
59
|
def initialize(socket, options = {})
|
|
60
60
|
super
|
|
61
61
|
|
|
62
|
-
@extensions = ::WebSocket::Extensions.new
|
|
62
|
+
@extensions = ::WebSocket::Extensions.new(:max_length => @max_length)
|
|
63
63
|
@stage = 0
|
|
64
64
|
@masking = options[:masking]
|
|
65
65
|
@protocols = options[:protocols] || []
|
|
@@ -190,7 +190,7 @@ module WebSocket
|
|
|
190
190
|
true
|
|
191
191
|
|
|
192
192
|
rescue ::WebSocket::Extensions::ExtensionError => error
|
|
193
|
-
fail(:extension_error, error.message)
|
|
193
|
+
fail(error.type || :extension_error, error.message)
|
|
194
194
|
end
|
|
195
195
|
|
|
196
196
|
private
|
|
@@ -271,7 +271,8 @@ module WebSocket
|
|
|
271
271
|
|
|
272
272
|
def fail(type, message)
|
|
273
273
|
return if @ready_state > 1
|
|
274
|
-
|
|
274
|
+
code = (Symbol === type) ? ERRORS[type] : type
|
|
275
|
+
shutdown(code, message, true)
|
|
275
276
|
end
|
|
276
277
|
|
|
277
278
|
def parse_opcode(octet)
|
|
@@ -422,7 +423,7 @@ module WebSocket
|
|
|
422
423
|
fail(:encoding_error, 'Could not decode a text frame as UTF-8')
|
|
423
424
|
end
|
|
424
425
|
rescue ::WebSocket::Extensions::ExtensionError => error
|
|
425
|
-
fail(:extension_error, error.message)
|
|
426
|
+
fail(error.type || :extension_error, error.message)
|
|
426
427
|
end
|
|
427
428
|
end
|
|
428
429
|
|
data/lib/websocket/driver.rb
CHANGED
|
@@ -71,17 +71,20 @@ module WebSocket
|
|
|
71
71
|
|
|
72
72
|
def initialize(socket, options = {})
|
|
73
73
|
super()
|
|
74
|
-
Driver.validate_options(options, [:max_length, :masking, :require_masking, :protocols, :binary_data_format])
|
|
75
74
|
|
|
76
75
|
@socket = socket
|
|
77
76
|
@reader = StreamReader.new
|
|
78
|
-
@options = options
|
|
77
|
+
@options = Driver.validate_options(options, [:allow_drafts, :max_length, :masking, :require_masking, :protocols, :binary_data_format])
|
|
79
78
|
@max_length = options[:max_length] || MAX_LENGTH
|
|
80
79
|
@headers = Headers.new
|
|
81
80
|
@queue = []
|
|
82
81
|
@ready_state = 0
|
|
83
82
|
|
|
84
|
-
|
|
83
|
+
if [nil, :array, :string].include?(@options[:binary_data_format])
|
|
84
|
+
@binary_data_format = options[:binary_data_format] || :string
|
|
85
|
+
else
|
|
86
|
+
raise ConfigurationError, "Invalid :binary_data_format: #{@options[:binary_data_format].inspect}"
|
|
87
|
+
end
|
|
85
88
|
end
|
|
86
89
|
|
|
87
90
|
def state
|
|
@@ -188,7 +191,7 @@ module WebSocket
|
|
|
188
191
|
key1 = env['HTTP_SEC_WEBSOCKET_KEY1']
|
|
189
192
|
key2 = env['HTTP_SEC_WEBSOCKET_KEY2']
|
|
190
193
|
|
|
191
|
-
if version or key
|
|
194
|
+
if !options[:allow_drafts] or version or key
|
|
192
195
|
Hybi.new(socket, options.merge(:require_masking => true))
|
|
193
196
|
elsif key1 or key2
|
|
194
197
|
Draft76.new(socket, options)
|
|
@@ -222,17 +225,7 @@ module WebSocket
|
|
|
222
225
|
end
|
|
223
226
|
|
|
224
227
|
def self.validate_options(options, valid_keys)
|
|
225
|
-
options
|
|
226
|
-
unless valid_keys.include?(key)
|
|
227
|
-
raise ConfigurationError, "Unrecognized option: #{ key.inspect }"
|
|
228
|
-
end
|
|
229
|
-
end
|
|
230
|
-
|
|
231
|
-
if options[:binary_data_format]
|
|
232
|
-
unless [:array, :string].include?(options[:binary_data_format])
|
|
233
|
-
raise ConfigurationError, "Invalid :binary_data_format: #{options[:binary_data_format].inspect}"
|
|
234
|
-
end
|
|
235
|
-
end
|
|
228
|
+
Extensions.validate_options(options, valid_keys)
|
|
236
229
|
end
|
|
237
230
|
|
|
238
231
|
def self.websocket?(env)
|
|
@@ -33,11 +33,18 @@ module WebSocket
|
|
|
33
33
|
rack_name = "HTTP_#{ rack_name }" unless RESERVED_HEADERS.include?(name)
|
|
34
34
|
@env[rack_name] = value
|
|
35
35
|
end
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
36
|
+
|
|
37
|
+
set_server_vars
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
def set_server_vars
|
|
41
|
+
return unless host = @env['HTTP_HOST']
|
|
42
|
+
|
|
43
|
+
uri = URI.parse("http://#{ host }")
|
|
44
|
+
@env['SERVER_NAME'] = uri.host
|
|
45
|
+
@env['SERVER_PORT'] = uri.port.to_s
|
|
46
|
+
rescue URI::InvalidURIError
|
|
47
|
+
error
|
|
41
48
|
end
|
|
42
49
|
end
|
|
43
50
|
|
data/lib/websocket_mask.jar
CHANGED
|
Binary file
|
metadata
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: websocket-driver
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.9.0
|
|
5
5
|
platform: java
|
|
6
6
|
authors:
|
|
7
7
|
- James Coglan
|
|
8
8
|
bindir: bin
|
|
9
9
|
cert_chain: []
|
|
10
|
-
date: 2026-
|
|
10
|
+
date: 2026-11-16 00:00:00.000000000 Z
|
|
11
11
|
dependencies:
|
|
12
12
|
- !ruby/object:Gem::Dependency
|
|
13
13
|
name: base64
|
|
@@ -29,14 +29,14 @@ dependencies:
|
|
|
29
29
|
requirements:
|
|
30
30
|
- - ">="
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
|
-
version: 0.
|
|
32
|
+
version: 0.2.0
|
|
33
33
|
type: :runtime
|
|
34
34
|
prerelease: false
|
|
35
35
|
version_requirements: !ruby/object:Gem::Requirement
|
|
36
36
|
requirements:
|
|
37
37
|
- - ">="
|
|
38
38
|
- !ruby/object:Gem::Version
|
|
39
|
-
version: 0.
|
|
39
|
+
version: 0.2.0
|
|
40
40
|
- !ruby/object:Gem::Dependency
|
|
41
41
|
name: eventmachine
|
|
42
42
|
requirement: !ruby/object:Gem::Requirement
|