mirror of
https://github.com/microsoft/vscode.git
synced 2026-09-09 10:42:28 +01:00
Connor Peet
0e07a325d6
Reject malformed request targets through the WebSocket verification callback instead of allowing URL parsing errors to escape and stop the Agent Host.\n\nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
84 lines
3.2 KiB
TypeScript
84 lines
3.2 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
import assert from 'assert';
|
|
import * as net from 'net';
|
|
import type * as wsTypes from 'ws';
|
|
import { Event } from '../../../../base/common/event.js';
|
|
import { toDisposable } from '../../../../base/common/lifecycle.js';
|
|
import { connectionTokenQueryName } from '../../../../base/common/network.js';
|
|
import { ensureNoDisposablesAreLeakedInTestSuite } from '../../../../base/test/common/utils.js';
|
|
import { NullLogService } from '../../../log/common/log.js';
|
|
import { WebSocketProtocolServer } from '../../node/webSocketTransport.js';
|
|
|
|
suite('WebSocketProtocolServer', () => {
|
|
const store = ensureNoDisposablesAreLeakedInTestSuite();
|
|
|
|
test('validates the decoded connection token', async () => {
|
|
const validatedTokens: unknown[] = [];
|
|
const server = store.add(await WebSocketProtocolServer.create({
|
|
port: 0,
|
|
connectionTokenValidate: token => {
|
|
validatedTokens.push(token);
|
|
return token === 'valid token';
|
|
},
|
|
}, new NullLogService()));
|
|
await server.whenListening;
|
|
|
|
const transport = Event.toPromise(server.onConnection);
|
|
const socket = await connect(`ws://127.0.0.1:${server.boundPort}/?${connectionTokenQueryName}=valid+token`);
|
|
store.add(toDisposable(() => socket.close()));
|
|
store.add(await transport);
|
|
|
|
assert.deepStrictEqual(validatedTokens, ['valid token']);
|
|
});
|
|
|
|
test('rejects a malformed request URL without stopping the server', async () => {
|
|
const server = store.add(await WebSocketProtocolServer.create({
|
|
port: 0,
|
|
connectionTokenValidate: token => token === 'valid',
|
|
}, new NullLogService()));
|
|
await server.whenListening;
|
|
|
|
const response = await sendUpgradeRequest(server.boundPort!, 'http://[invalid');
|
|
const transport = Event.toPromise(server.onConnection);
|
|
const socket = await connect(`ws://127.0.0.1:${server.boundPort}/?${connectionTokenQueryName}=valid`);
|
|
store.add(toDisposable(() => socket.close()));
|
|
store.add(await transport);
|
|
|
|
assert.strictEqual(response.split('\r\n', 1)[0], 'HTTP/1.1 400 Bad Request');
|
|
});
|
|
});
|
|
|
|
async function connect(url: string): Promise<wsTypes.WebSocket> {
|
|
const { WebSocket } = await import('ws');
|
|
return new Promise((resolve, reject) => {
|
|
const socket = new WebSocket(url);
|
|
socket.once('open', () => resolve(socket));
|
|
socket.once('error', reject);
|
|
});
|
|
}
|
|
|
|
function sendUpgradeRequest(port: number, requestTarget: string): Promise<string> {
|
|
return new Promise((resolve, reject) => {
|
|
const socket = net.createConnection({ host: '127.0.0.1', port }, () => {
|
|
socket.end([
|
|
`GET ${requestTarget} HTTP/1.1`,
|
|
'Host: localhost',
|
|
'Connection: Upgrade',
|
|
'Upgrade: websocket',
|
|
'Sec-WebSocket-Version: 13',
|
|
'Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==',
|
|
'',
|
|
'',
|
|
].join('\r\n'));
|
|
});
|
|
const chunks: Buffer[] = [];
|
|
socket.on('data', chunk => chunks.push(Buffer.from(chunk)));
|
|
socket.on('end', () => resolve(Buffer.concat(chunks).toString()));
|
|
socket.on('error', reject);
|
|
});
|
|
}
|