Skip to content

fix(websocket): strip surrounding whitespace in parseExtensions #5714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arshsmith1 wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −3
Open

fix(websocket): strip surrounding whitespace in parseExtensions #5714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/web/websocket/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,8 @@ function parseExtensions (extensions) {
const [name, value = ''] = pair.split('=', 2)

extensionList.set(
removeHTTPWhitespace(name, true, false),
removeHTTPWhitespace(value, false, true)
removeHTTPWhitespace(name, true, true),
removeHTTPWhitespace(value, true, true)
)

position.position++
Expand Down
22 changes: 21 additions & 1 deletion test/websocket/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict'

const { describe, test } = require('node:test')
const { isValidSubprotocol } = require('../../lib/web/websocket/util')
const { isValidSubprotocol, parseExtensions } = require('../../lib/web/websocket/util')

describe('isValidSubprotocol', () => {
test('empty string returns false', t => {
Expand All @@ -28,3 +28,23 @@ describe('isValidSubprotocol', () => {
}
})
})

describe('parseExtensions', () => {
test('keeps whitespace out of parameter names and values', t => {
// Optional whitespace is allowed around the ";" and "=" delimiters of an
// extension header, so it must be stripped from both ends of every name
// and value before the map is keyed on them.
const cases = {
'permessage-deflate; client_max_window_bits': [['permessage-deflate', ''], ['client_max_window_bits', '']],
'permessage-deflate ; client_max_window_bits': [['permessage-deflate', ''], ['client_max_window_bits', '']],
'permessage-deflate;\tclient_max_window_bits': [['permessage-deflate', ''], ['client_max_window_bits', '']],
'permessage-deflate; server_max_window_bits = 10': [['permessage-deflate', ''], ['server_max_window_bits', '10']],
'permessage-deflate; server_max_window_bits=10 ': [['permessage-deflate', ''], ['server_max_window_bits', '10']]
}

t.plan(Object.keys(cases).length)
for (const [header, expected] of Object.entries(cases)) {
t.assert.deepStrictEqual([...parseExtensions(header).entries()], expected, header)
}
})
})
Loading