WebSocket: wrong subprotocol choose check (response Sec-WebSocket-Protocol header)

Bug Description

client sends Sec-WebSocket-Protocol header with protocol list (separated by ',')
server responds with one protocol from this list
WebSocket client compares request header (protocol list) with response header (one protocol) value and fails with the error Protocol was not set in the opening handshake

Line 179 in c49058b

    
           if (secProtocol !== null && secProtocol !== request.headersList.get('Sec-WebSocket-Protocol')) {

Reproducible By

let ws = new WebSocket('ws://server...', ['msgpack', 'json'])
ws.addEventListener('error', e => console.log(e.error))
// server choses json and responds with `Sec-WebSocket-Protocol: json`
// client failed

Expected Behavior

Correct subprotocol check

Environment

Node.js v21.6.2
--experimental-websocket flag

I will have a fix for this soon.

Relevant part of the specification:

   The client can request that the server use a specific subprotocol by
   including the |Sec-WebSocket-Protocol| field in its handshake.  If it
   is specified, the server needs to include the same field and one of
   the selected subprotocol values in its response for the connection to
   be established.

https://datatracker.ietf.org/doc/html/rfc6455#section-1.9

@KhafraDev

@KhafraDev, is there a chance to backport this to Node.js v18? This bug breaks WebSocket connections with multiple protocols.

Navigation Menu

Repository navigation

WebSocket: wrong subprotocol choose check (response Sec-WebSocket-Protocol header) #2844

Bug Description

Reproducible By

Expected Behavior

Environment

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

WebSocket: wrong subprotocol choose check (response Sec-WebSocket-Protocol header) #2844

Description

Bug Description

Reproducible By

Expected Behavior

Environment

Activity

KhafraDev commented on Feb 25, 2024

kettanaito commented on Aug 1, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions