Bump ws from 8.8.0 to 8.17.1
Bumps ws from 8.8.0 to 8.17.1.
Release notes
Sourced from ws's releases.
8.17.1
Bug fixes
- Fixed a DoS vulnerability (#2231).
A request with a number of headers exceeding the[
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 websockets/ws#2230.
In vulnerable versions of ws, the issue can be mitigated in the following ways:
- 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 theserver.maxHeadersCountlimit can be sent.
... (truncated)
Commits
3c56601[dist] 8.17.1e55e510[security] Fix crash when the Upgrade header cannot be read (#2231)6a00029[test] Increase code coverageddfe4a8[perf] Reduce the amount ofcrypto.randomFillSync()callsb73b118[dist] 8.17.029694a5[test] Use thehighWaterMarkvariable934c9d6[ci] Test on node 221817bac[ci] Do not test on node 2196c9b3d[major] Flip the default value ofallowSynchronousEvents(#2221)e5f32c7[fix] Emit at most one event per event loop iteration (#2218)- Additional commits viewable in compare view
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
-
@dependabot rebasewill rebase this PR -
@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it -
@dependabot mergewill merge this PR after your CI passes on it -
@dependabot squash and mergewill squash and merge this PR after your CI passes on it -
@dependabot cancel mergewill cancel a previously requested merge and block automerging -
@dependabot reopenwill reopen this PR if it is closed -
@dependabot closewill close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually -
@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency -
@dependabot ignore this major versionwill close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) -
@dependabot ignore this minor versionwill close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) -
@dependabot ignore this dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the Security Alerts page.
[puLL-Merge] - websockets/[email protected]
Description
This pull request introduces a diverse range of updates encompassing the CI/CD pipeline, code quality configurations, licensing changes, documentation improvements, and error handling enhancements for the websockets/ws repository.
Changes
Changes
Here is a detailed list of the main changes introduced in this PR, organized by filename:
.eslintrc.yaml
- Removed the old
.eslintrc.yamlconfiguration file.
.github/workflows/ci.yml
- Added Node.js versions 20 and 22 to the CI matrix.
- Updated checkout and setup-node actions to versions 4.
- Enabled caching for npm dependencies.
- Adjusted conditional logic to use the latest Node.js version for linting.
- Enhanced some steps for better compatibility with new syntax.
FUNDING.json
- Added a new
FUNDING.jsonfile for Ethereum drips funding.
LICENSE
- Updated to include additional contributors and modified formatting.
README.md
- Fixed broken link to the GitHub Actions CI badge.
- Corrected some language for clarity.
- Added more details about performance opt-ins, including legacy support for older Node.js versions.
- Enhanced some examples with error handlers.
- Updated to reflect changes in project structure and dependencies.
SECURITY.md
- Improved language for better clarity.
- Updated process for acknowledgment of vulnerability reports.
doc/ws.md
- Corrected minor markdown format issues.
- Added new configuration options like
autoPongandallowSynchronousEventsforWebSocketServer. - Clarified documentation for extended payload lengths, IPC connections, and custom request headers.
eslint.config.js
- Created a new ESLint configuration.
- Set up ESLint with Prettier integration and defined environment options.
examples/**/*.js
- Added missing error event listeners to all WebSocket examples.
- Introduced common error handling functions.
lib/**/*.js
- Added support for fast buffer slicing using
Buffer[Symbol.species]. - Enhanced error creation functionality in
receiver.js. - Implemented new states and methods, improving the processing flow of WebSocket frames and extending compatibility with specification.
- Improved performance of some buffer operations and validation checks.
- Updated some methods to ensure better reliability and consistency.
package.json
- Bumped version from
8.8.0to8.17.1. - Revamped
exportsfor better module resolution. - Updated development dependencies, including improvements for ESLint and Prettier.
- Added new scripts and adjusted existing ones for better package management.
test/**/*.js
- Added tests to verify compatibility with new features and configuration options.
- Created new tests for IPC connection handling.
- Enhanced some test cases to be more robust and cover edge scenarios.
Security Hotspots
No significant security hotspots identified. The changes generally sort out better error handling, improved configuration processing, and more extensive testing which translates to enhanced security indirectly.
Possible Issues
- Backward Compatibility: Some updates such as changes in Node.js version requirements and improved ESLint setups might lead to compatibility issues with legacy systems.
- Test Coverage: Although the PR has added several test cases, further tests in less covered scenarios should be added for comprehensive test coverage.
Overall, the PR introduces substantial improvements and updates to the websockets/ws repository. The changes enhance configuration, documentation, and error handling, contributing to a more robust and maintainable codebase. The highlighted areas, especially around backward compatibility, should be carefully reviewed and tested before merging.