Skip to content

Commit fad98ae

Browse files
authored
fix: close rejected HTTP/2 WebSocket streams on v7.x (#5876)
Signed-off-by: Matteo Collina <[email protected]>
1 parent 369058e commit fad98ae

2 files changed

Lines changed: 69 additions & 8 deletions

File tree

‎lib/web/websocket/connection.js‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,13 @@ function establishWebSocketConnection (url, protocols, client, handler, options)
101101
// The presence of a session property on the socket indicates HTTP2
102102
// HTTP1
103103
if (response.socket?.session == null) {
104-
failWebsocketConnection(handler, 1002, 'Received network error or non-101 status code.', response.error)
104+
failHandshake(handler, response, 1002, 'Received network error or non-101 status code.', response.error)
105105
return
106106
}
107107

108108
// HTTP2
109109
if (response.status !== 200) {
110-
failWebsocketConnection(handler, 1002, 'Received network error or non-200 status code.', response.error)
110+
failHandshake(handler, response, 1002, 'Received network error or non-200 status code.', response.error)
111111
return
112112
}
113113
}
@@ -122,7 +122,7 @@ function establishWebSocketConnection (url, protocols, client, handler, options)
122122
// header list results in null, failure, or the empty byte
123123
// sequence, then fail the WebSocket connection.
124124
if (protocols.length !== 0 && !response.headersList.get('Sec-WebSocket-Protocol')) {
125-
failWebsocketConnection(handler, 1002, 'Server did not respond with sent protocols.')
125+
failHandshake(handler, response, 1002, 'Server did not respond with sent protocols.')
126126
return
127127
}
128128

@@ -138,7 +138,7 @@ function establishWebSocketConnection (url, protocols, client, handler, options)
138138
// _Fail the WebSocket Connection_.
139139
// For H2, no upgrade header is expected.
140140
if (response.socket.session == null && response.headersList.get('Upgrade')?.toLowerCase() !== 'websocket') {
141-
failWebsocketConnection(handler, 1002, 'Server did not set Upgrade header to "websocket".')
141+
failHandshake(handler, response, 1002, 'Server did not set Upgrade header to "websocket".')
142142
return
143143
}
144144

@@ -148,7 +148,7 @@ function establishWebSocketConnection (url, protocols, client, handler, options)
148148
// MUST _Fail the WebSocket Connection_.
149149
// For H2, no connection header is expected.
150150
if (response.socket.session == null && response.headersList.get('Connection')?.toLowerCase() !== 'upgrade') {
151-
failWebsocketConnection(handler, 1002, 'Server did not set Connection header to "upgrade".')
151+
failHandshake(handler, response, 1002, 'Server did not set Connection header to "upgrade".')
152152
return
153153
}
154154

@@ -162,7 +162,7 @@ function establishWebSocketConnection (url, protocols, client, handler, options)
162162
const secWSAccept = response.headersList.get('Sec-WebSocket-Accept')
163163
const digest = crypto.hash('sha1', keyValue + uid, 'base64')
164164
if (secWSAccept !== digest) {
165-
failWebsocketConnection(handler, 1002, 'Incorrect hash received in Sec-WebSocket-Accept header.')
165+
failHandshake(handler, response, 1002, 'Incorrect hash received in Sec-WebSocket-Accept header.')
166166
return
167167
}
168168

@@ -180,7 +180,7 @@ function establishWebSocketConnection (url, protocols, client, handler, options)
180180
extensions = parseExtensions(secExtension)
181181

182182
if (!extensions.has('permessage-deflate')) {
183-
failWebsocketConnection(handler, 1002, 'Sec-WebSocket-Extensions header does not match.')
183+
failHandshake(handler, response, 1002, 'Sec-WebSocket-Extensions header does not match.')
184184
return
185185
}
186186
}
@@ -201,7 +201,7 @@ function establishWebSocketConnection (url, protocols, client, handler, options)
201201
// the selected subprotocol values in its response for the connection to
202202
// be established.
203203
if (requestProtocols === null || !requestProtocols.includes(secProtocol)) {
204-
failWebsocketConnection(handler, 1002, 'Protocol was not set in the opening handshake.')
204+
failHandshake(handler, response, 1002, 'Protocol was not set in the opening handshake.')
205205
return
206206
}
207207
}
@@ -296,6 +296,16 @@ function closeWebSocketConnection (object, code, reason, validate = false) {
296296
}
297297
}
298298

299+
function failHandshake (handler, response, code, reason, cause) {
300+
// The H2 upgrade request has already completed and handed off its stream.
301+
// Aborting the request cannot close that stream after handshake validation fails.
302+
if (response.socket?.session != null && !response.socket.destroyed) {
303+
response.socket.destroy()
304+
}
305+
306+
failWebsocketConnection(handler, code, reason, cause)
307+
}
308+
299309
/**
300310
* @param {import('./websocket').Handler} handler
301311
* @param {number} code
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
'use strict'
2+
3+
const { test } = require('node:test')
4+
const { once } = require('node:events')
5+
const { createSecureServer } = require('node:http2')
6+
const { key, cert } = require('@metcoder95/https-pem')
7+
const { Agent, WebSocket } = require('../..')
8+
const { runtimeFeatures } = require('../../lib/util/runtime-features')
9+
10+
for (const responseHeaders of [
11+
{ ':status': 200 },
12+
{ ':status': 200, 'sec-websocket-protocol': 'chat', 'sec-websocket-accept': 'invalid' }
13+
]) {
14+
test('a rejected H2 WebSocket handshake closes its stream', { skip: !runtimeFeatures.has('crypto'), timeout: 10000 }, async (t) => {
15+
const server = createSecureServer({ key, cert, settings: { enableConnectProtocol: true } })
16+
const sessions = new Set()
17+
let closeStream
18+
const streamClosed = new Promise((resolve) => { closeStream = resolve })
19+
20+
server.on('session', (session) => {
21+
sessions.add(session)
22+
session.on('close', () => sessions.delete(session))
23+
})
24+
server.on('stream', (stream) => {
25+
stream.on('error', () => {})
26+
stream.once('close', closeStream)
27+
stream.respond(responseHeaders)
28+
// Leave the stream open: the client must close it after rejecting the handshake.
29+
})
30+
31+
server.listen(0)
32+
await once(server, 'listening')
33+
const dispatcher = new Agent({ allowH2: true, connect: { rejectUnauthorized: false } })
34+
t.after(async () => {
35+
for (const session of sessions) session.destroy()
36+
await new Promise((resolve) => server.close(resolve))
37+
await dispatcher.close()
38+
})
39+
40+
const ws = new WebSocket(`wss://localhost:${server.address().port}`, { dispatcher, protocols: ['chat'] })
41+
ws.addEventListener('error', () => {})
42+
ws.addEventListener('open', () => t.assert.fail('handshake should be rejected'))
43+
const [close] = await once(ws, 'close')
44+
t.assert.strictEqual(close.code, 1006)
45+
46+
await new Promise((resolve, reject) => {
47+
const timer = setTimeout(() => reject(new Error('H2 stream remained open after WebSocket closed')), 1000)
48+
streamClosed.then(() => { clearTimeout(timer); resolve() })
49+
})
50+
})
51+
}

0 commit comments

Comments
 (0)