1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174 |
- 'use strict';
- const EventEmitter = require('events');
- const https = require('https');
- const http = require('http');
- const net = require('net');
- const tls = require('tls');
- const { randomBytes, createHash } = require('crypto');
- const { Readable } = require('stream');
- const { URL } = require('url');
- const PerMessageDeflate = require('./permessage-deflate');
- const Receiver = require('./receiver');
- const Sender = require('./sender');
- const {
- BINARY_TYPES,
- EMPTY_BUFFER,
- GUID,
- kStatusCode,
- kWebSocket,
- NOOP
- } = require('./constants');
- const { addEventListener, removeEventListener } = require('./event-target');
- const { format, parse } = require('./extension');
- const { toBuffer } = require('./buffer-util');
- const readyStates = ['CONNECTING', 'OPEN', 'CLOSING', 'CLOSED'];
- const protocolVersions = [8, 13];
- const closeTimeout = 30 * 1000;
- class WebSocket extends EventEmitter {
-
- constructor(address, protocols, options) {
- super();
- this._binaryType = BINARY_TYPES[0];
- this._closeCode = 1006;
- this._closeFrameReceived = false;
- this._closeFrameSent = false;
- this._closeMessage = '';
- this._closeTimer = null;
- this._extensions = {};
- this._protocol = '';
- this._readyState = WebSocket.CONNECTING;
- this._receiver = null;
- this._sender = null;
- this._socket = null;
- if (address !== null) {
- this._bufferedAmount = 0;
- this._isServer = false;
- this._redirects = 0;
- if (Array.isArray(protocols)) {
- protocols = protocols.join(', ');
- } else if (typeof protocols === 'object' && protocols !== null) {
- options = protocols;
- protocols = undefined;
- }
- initAsClient(this, address, protocols, options);
- } else {
- this._isServer = true;
- }
- }
-
- get binaryType() {
- return this._binaryType;
- }
- set binaryType(type) {
- if (!BINARY_TYPES.includes(type)) return;
- this._binaryType = type;
-
-
-
- if (this._receiver) this._receiver._binaryType = type;
- }
-
- get bufferedAmount() {
- if (!this._socket) return this._bufferedAmount;
- return this._socket._writableState.length + this._sender._bufferedBytes;
- }
-
- get extensions() {
- return Object.keys(this._extensions).join();
- }
-
-
- get onclose() {
- return undefined;
- }
-
- set onclose(listener) {}
-
-
- get onerror() {
- return undefined;
- }
-
- set onerror(listener) {}
-
-
- get onopen() {
- return undefined;
- }
-
- set onopen(listener) {}
-
-
- get onmessage() {
- return undefined;
- }
-
- set onmessage(listener) {}
-
- get protocol() {
- return this._protocol;
- }
-
- get readyState() {
- return this._readyState;
- }
-
- get url() {
- return this._url;
- }
-
- setSocket(socket, head, maxPayload) {
- const receiver = new Receiver(
- this.binaryType,
- this._extensions,
- this._isServer,
- maxPayload
- );
- this._sender = new Sender(socket, this._extensions);
- this._receiver = receiver;
- this._socket = socket;
- receiver[kWebSocket] = this;
- socket[kWebSocket] = this;
- receiver.on('conclude', receiverOnConclude);
- receiver.on('drain', receiverOnDrain);
- receiver.on('error', receiverOnError);
- receiver.on('message', receiverOnMessage);
- receiver.on('ping', receiverOnPing);
- receiver.on('pong', receiverOnPong);
- socket.setTimeout(0);
- socket.setNoDelay();
- if (head.length > 0) socket.unshift(head);
- socket.on('close', socketOnClose);
- socket.on('data', socketOnData);
- socket.on('end', socketOnEnd);
- socket.on('error', socketOnError);
- this._readyState = WebSocket.OPEN;
- this.emit('open');
- }
-
- emitClose() {
- if (!this._socket) {
- this._readyState = WebSocket.CLOSED;
- this.emit('close', this._closeCode, this._closeMessage);
- return;
- }
- if (this._extensions[PerMessageDeflate.extensionName]) {
- this._extensions[PerMessageDeflate.extensionName].cleanup();
- }
- this._receiver.removeAllListeners();
- this._readyState = WebSocket.CLOSED;
- this.emit('close', this._closeCode, this._closeMessage);
- }
-
- close(code, data) {
- if (this.readyState === WebSocket.CLOSED) return;
- if (this.readyState === WebSocket.CONNECTING) {
- const msg = 'WebSocket was closed before the connection was established';
- return abortHandshake(this, this._req, msg);
- }
- if (this.readyState === WebSocket.CLOSING) {
- if (
- this._closeFrameSent &&
- (this._closeFrameReceived || this._receiver._writableState.errorEmitted)
- ) {
- this._socket.end();
- }
- return;
- }
- this._readyState = WebSocket.CLOSING;
- this._sender.close(code, data, !this._isServer, (err) => {
-
-
-
-
- if (err) return;
- this._closeFrameSent = true;
- if (
- this._closeFrameReceived ||
- this._receiver._writableState.errorEmitted
- ) {
- this._socket.end();
- }
- });
-
-
-
- this._closeTimer = setTimeout(
- this._socket.destroy.bind(this._socket),
- closeTimeout
- );
- }
-
- ping(data, mask, cb) {
- if (this.readyState === WebSocket.CONNECTING) {
- throw new Error('WebSocket is not open: readyState 0 (CONNECTING)');
- }
- if (typeof data === 'function') {
- cb = data;
- data = mask = undefined;
- } else if (typeof mask === 'function') {
- cb = mask;
- mask = undefined;
- }
- if (typeof data === 'number') data = data.toString();
- if (this.readyState !== WebSocket.OPEN) {
- sendAfterClose(this, data, cb);
- return;
- }
- if (mask === undefined) mask = !this._isServer;
- this._sender.ping(data || EMPTY_BUFFER, mask, cb);
- }
-
- pong(data, mask, cb) {
- if (this.readyState === WebSocket.CONNECTING) {
- throw new Error('WebSocket is not open: readyState 0 (CONNECTING)');
- }
- if (typeof data === 'function') {
- cb = data;
- data = mask = undefined;
- } else if (typeof mask === 'function') {
- cb = mask;
- mask = undefined;
- }
- if (typeof data === 'number') data = data.toString();
- if (this.readyState !== WebSocket.OPEN) {
- sendAfterClose(this, data, cb);
- return;
- }
- if (mask === undefined) mask = !this._isServer;
- this._sender.pong(data || EMPTY_BUFFER, mask, cb);
- }
-
- send(data, options, cb) {
- if (this.readyState === WebSocket.CONNECTING) {
- throw new Error('WebSocket is not open: readyState 0 (CONNECTING)');
- }
- if (typeof options === 'function') {
- cb = options;
- options = {};
- }
- if (typeof data === 'number') data = data.toString();
- if (this.readyState !== WebSocket.OPEN) {
- sendAfterClose(this, data, cb);
- return;
- }
- const opts = {
- binary: typeof data !== 'string',
- mask: !this._isServer,
- compress: true,
- fin: true,
- ...options
- };
- if (!this._extensions[PerMessageDeflate.extensionName]) {
- opts.compress = false;
- }
- this._sender.send(data || EMPTY_BUFFER, opts, cb);
- }
-
- terminate() {
- if (this.readyState === WebSocket.CLOSED) return;
- if (this.readyState === WebSocket.CONNECTING) {
- const msg = 'WebSocket was closed before the connection was established';
- return abortHandshake(this, this._req, msg);
- }
- if (this._socket) {
- this._readyState = WebSocket.CLOSING;
- this._socket.destroy();
- }
- }
- }
- Object.defineProperty(WebSocket, 'CONNECTING', {
- enumerable: true,
- value: readyStates.indexOf('CONNECTING')
- });
- Object.defineProperty(WebSocket.prototype, 'CONNECTING', {
- enumerable: true,
- value: readyStates.indexOf('CONNECTING')
- });
- Object.defineProperty(WebSocket, 'OPEN', {
- enumerable: true,
- value: readyStates.indexOf('OPEN')
- });
- Object.defineProperty(WebSocket.prototype, 'OPEN', {
- enumerable: true,
- value: readyStates.indexOf('OPEN')
- });
- Object.defineProperty(WebSocket, 'CLOSING', {
- enumerable: true,
- value: readyStates.indexOf('CLOSING')
- });
- Object.defineProperty(WebSocket.prototype, 'CLOSING', {
- enumerable: true,
- value: readyStates.indexOf('CLOSING')
- });
- Object.defineProperty(WebSocket, 'CLOSED', {
- enumerable: true,
- value: readyStates.indexOf('CLOSED')
- });
- Object.defineProperty(WebSocket.prototype, 'CLOSED', {
- enumerable: true,
- value: readyStates.indexOf('CLOSED')
- });
- [
- 'binaryType',
- 'bufferedAmount',
- 'extensions',
- 'protocol',
- 'readyState',
- 'url'
- ].forEach((property) => {
- Object.defineProperty(WebSocket.prototype, property, { enumerable: true });
- });
- ['open', 'error', 'close', 'message'].forEach((method) => {
- Object.defineProperty(WebSocket.prototype, `on${method}`, {
- enumerable: true,
- get() {
- const listeners = this.listeners(method);
- for (let i = 0; i < listeners.length; i++) {
- if (listeners[i]._listener) return listeners[i]._listener;
- }
- return undefined;
- },
- set(listener) {
- const listeners = this.listeners(method);
- for (let i = 0; i < listeners.length; i++) {
-
-
-
- if (listeners[i]._listener) this.removeListener(method, listeners[i]);
- }
- this.addEventListener(method, listener);
- }
- });
- });
- WebSocket.prototype.addEventListener = addEventListener;
- WebSocket.prototype.removeEventListener = removeEventListener;
- module.exports = WebSocket;
- function initAsClient(websocket, address, protocols, options) {
- const opts = {
- protocolVersion: protocolVersions[1],
- maxPayload: 100 * 1024 * 1024,
- perMessageDeflate: true,
- followRedirects: false,
- maxRedirects: 10,
- ...options,
- createConnection: undefined,
- socketPath: undefined,
- hostname: undefined,
- protocol: undefined,
- timeout: undefined,
- method: undefined,
- host: undefined,
- path: undefined,
- port: undefined
- };
- if (!protocolVersions.includes(opts.protocolVersion)) {
- throw new RangeError(
- `Unsupported protocol version: ${opts.protocolVersion} ` +
- `(supported versions: ${protocolVersions.join(', ')})`
- );
- }
- let parsedUrl;
- if (address instanceof URL) {
- parsedUrl = address;
- websocket._url = address.href;
- } else {
- parsedUrl = new URL(address);
- websocket._url = address;
- }
- const isUnixSocket = parsedUrl.protocol === 'ws+unix:';
- if (!parsedUrl.host && (!isUnixSocket || !parsedUrl.pathname)) {
- const err = new Error(`Invalid URL: ${websocket.url}`);
- if (websocket._redirects === 0) {
- throw err;
- } else {
- emitErrorAndClose(websocket, err);
- return;
- }
- }
- const isSecure =
- parsedUrl.protocol === 'wss:' || parsedUrl.protocol === 'https:';
- const defaultPort = isSecure ? 443 : 80;
- const key = randomBytes(16).toString('base64');
- const get = isSecure ? https.get : http.get;
- let perMessageDeflate;
- opts.createConnection = isSecure ? tlsConnect : netConnect;
- opts.defaultPort = opts.defaultPort || defaultPort;
- opts.port = parsedUrl.port || defaultPort;
- opts.host = parsedUrl.hostname.startsWith('[')
- ? parsedUrl.hostname.slice(1, -1)
- : parsedUrl.hostname;
- opts.headers = {
- 'Sec-WebSocket-Version': opts.protocolVersion,
- 'Sec-WebSocket-Key': key,
- Connection: 'Upgrade',
- Upgrade: 'websocket',
- ...opts.headers
- };
- opts.path = parsedUrl.pathname + parsedUrl.search;
- opts.timeout = opts.handshakeTimeout;
- if (opts.perMessageDeflate) {
- perMessageDeflate = new PerMessageDeflate(
- opts.perMessageDeflate !== true ? opts.perMessageDeflate : {},
- false,
- opts.maxPayload
- );
- opts.headers['Sec-WebSocket-Extensions'] = format({
- [PerMessageDeflate.extensionName]: perMessageDeflate.offer()
- });
- }
- if (protocols) {
- opts.headers['Sec-WebSocket-Protocol'] = protocols;
- }
- if (opts.origin) {
- if (opts.protocolVersion < 13) {
- opts.headers['Sec-WebSocket-Origin'] = opts.origin;
- } else {
- opts.headers.Origin = opts.origin;
- }
- }
- if (parsedUrl.username || parsedUrl.password) {
- opts.auth = `${parsedUrl.username}:${parsedUrl.password}`;
- }
- if (isUnixSocket) {
- const parts = opts.path.split(':');
- opts.socketPath = parts[0];
- opts.path = parts[1];
- }
- if (opts.followRedirects) {
- if (websocket._redirects === 0) {
- websocket._originalHost = parsedUrl.host;
- const headers = options && options.headers;
-
-
-
-
- options = { ...options, headers: {} };
- if (headers) {
- for (const [key, value] of Object.entries(headers)) {
- options.headers[key.toLowerCase()] = value;
- }
- }
- } else if (parsedUrl.host !== websocket._originalHost) {
-
-
-
-
- delete opts.headers.authorization;
- delete opts.headers.cookie;
- delete opts.headers.host;
- opts.auth = undefined;
- }
-
-
-
-
-
- if (opts.auth && !options.headers.authorization) {
- options.headers.authorization =
- 'Basic ' + Buffer.from(opts.auth).toString('base64');
- }
- }
- let req = (websocket._req = get(opts));
- if (opts.timeout) {
- req.on('timeout', () => {
- abortHandshake(websocket, req, 'Opening handshake has timed out');
- });
- }
- req.on('error', (err) => {
- if (req === null || req.aborted) return;
- req = websocket._req = null;
- emitErrorAndClose(websocket, err);
- });
- req.on('response', (res) => {
- const location = res.headers.location;
- const statusCode = res.statusCode;
- if (
- location &&
- opts.followRedirects &&
- statusCode >= 300 &&
- statusCode < 400
- ) {
- if (++websocket._redirects > opts.maxRedirects) {
- abortHandshake(websocket, req, 'Maximum redirects exceeded');
- return;
- }
- req.abort();
- let addr;
- try {
- addr = new URL(location, address);
- } catch (err) {
- emitErrorAndClose(websocket, err);
- return;
- }
- initAsClient(websocket, addr, protocols, options);
- } else if (!websocket.emit('unexpected-response', req, res)) {
- abortHandshake(
- websocket,
- req,
- `Unexpected server response: ${res.statusCode}`
- );
- }
- });
- req.on('upgrade', (res, socket, head) => {
- websocket.emit('upgrade', res);
-
-
-
-
- if (websocket.readyState !== WebSocket.CONNECTING) return;
- req = websocket._req = null;
- const digest = createHash('sha1')
- .update(key + GUID)
- .digest('base64');
- if (res.headers['sec-websocket-accept'] !== digest) {
- abortHandshake(websocket, socket, 'Invalid Sec-WebSocket-Accept header');
- return;
- }
- const serverProt = res.headers['sec-websocket-protocol'];
- const protList = (protocols || '').split(/, */);
- let protError;
- if (!protocols && serverProt) {
- protError = 'Server sent a subprotocol but none was requested';
- } else if (protocols && !serverProt) {
- protError = 'Server sent no subprotocol';
- } else if (serverProt && !protList.includes(serverProt)) {
- protError = 'Server sent an invalid subprotocol';
- }
- if (protError) {
- abortHandshake(websocket, socket, protError);
- return;
- }
- if (serverProt) websocket._protocol = serverProt;
- const secWebSocketExtensions = res.headers['sec-websocket-extensions'];
- if (secWebSocketExtensions !== undefined) {
- if (!perMessageDeflate) {
- const message =
- 'Server sent a Sec-WebSocket-Extensions header but no extension ' +
- 'was requested';
- abortHandshake(websocket, socket, message);
- return;
- }
- let extensions;
- try {
- extensions = parse(secWebSocketExtensions);
- } catch (err) {
- const message = 'Invalid Sec-WebSocket-Extensions header';
- abortHandshake(websocket, socket, message);
- return;
- }
- const extensionNames = Object.keys(extensions);
- if (extensionNames.length) {
- if (
- extensionNames.length !== 1 ||
- extensionNames[0] !== PerMessageDeflate.extensionName
- ) {
- const message =
- 'Server indicated an extension that was not requested';
- abortHandshake(websocket, socket, message);
- return;
- }
- try {
- perMessageDeflate.accept(extensions[PerMessageDeflate.extensionName]);
- } catch (err) {
- const message = 'Invalid Sec-WebSocket-Extensions header';
- abortHandshake(websocket, socket, message);
- return;
- }
- websocket._extensions[PerMessageDeflate.extensionName] =
- perMessageDeflate;
- }
- }
- websocket.setSocket(socket, head, opts.maxPayload);
- });
- }
- function emitErrorAndClose(websocket, err) {
- websocket._readyState = WebSocket.CLOSING;
- websocket.emit('error', err);
- websocket.emitClose();
- }
- function netConnect(options) {
- options.path = options.socketPath;
- return net.connect(options);
- }
- function tlsConnect(options) {
- options.path = undefined;
- if (!options.servername && options.servername !== '') {
- options.servername = net.isIP(options.host) ? '' : options.host;
- }
- return tls.connect(options);
- }
- function abortHandshake(websocket, stream, message) {
- websocket._readyState = WebSocket.CLOSING;
- const err = new Error(message);
- Error.captureStackTrace(err, abortHandshake);
- if (stream.setHeader) {
- stream.abort();
- if (stream.socket && !stream.socket.destroyed) {
-
-
-
-
-
- stream.socket.destroy();
- }
- stream.once('abort', websocket.emitClose.bind(websocket));
- websocket.emit('error', err);
- } else {
- stream.destroy(err);
- stream.once('error', websocket.emit.bind(websocket, 'error'));
- stream.once('close', websocket.emitClose.bind(websocket));
- }
- }
- function sendAfterClose(websocket, data, cb) {
- if (data) {
- const length = toBuffer(data).length;
-
-
-
-
-
-
- if (websocket._socket) websocket._sender._bufferedBytes += length;
- else websocket._bufferedAmount += length;
- }
- if (cb) {
- const err = new Error(
- `WebSocket is not open: readyState ${websocket.readyState} ` +
- `(${readyStates[websocket.readyState]})`
- );
- cb(err);
- }
- }
- function receiverOnConclude(code, reason) {
- const websocket = this[kWebSocket];
- websocket._closeFrameReceived = true;
- websocket._closeMessage = reason;
- websocket._closeCode = code;
- if (websocket._socket[kWebSocket] === undefined) return;
- websocket._socket.removeListener('data', socketOnData);
- process.nextTick(resume, websocket._socket);
- if (code === 1005) websocket.close();
- else websocket.close(code, reason);
- }
- function receiverOnDrain() {
- this[kWebSocket]._socket.resume();
- }
- function receiverOnError(err) {
- const websocket = this[kWebSocket];
- if (websocket._socket[kWebSocket] !== undefined) {
- websocket._socket.removeListener('data', socketOnData);
-
-
-
-
- process.nextTick(resume, websocket._socket);
- websocket.close(err[kStatusCode]);
- }
- websocket.emit('error', err);
- }
- function receiverOnFinish() {
- this[kWebSocket].emitClose();
- }
- function receiverOnMessage(data) {
- this[kWebSocket].emit('message', data);
- }
- function receiverOnPing(data) {
- const websocket = this[kWebSocket];
- websocket.pong(data, !websocket._isServer, NOOP);
- websocket.emit('ping', data);
- }
- function receiverOnPong(data) {
- this[kWebSocket].emit('pong', data);
- }
- function resume(stream) {
- stream.resume();
- }
- function socketOnClose() {
- const websocket = this[kWebSocket];
- this.removeListener('close', socketOnClose);
- this.removeListener('data', socketOnData);
- this.removeListener('end', socketOnEnd);
- websocket._readyState = WebSocket.CLOSING;
- let chunk;
-
-
-
-
-
-
-
-
-
- if (
- !this._readableState.endEmitted &&
- !websocket._closeFrameReceived &&
- !websocket._receiver._writableState.errorEmitted &&
- (chunk = websocket._socket.read()) !== null
- ) {
- websocket._receiver.write(chunk);
- }
- websocket._receiver.end();
- this[kWebSocket] = undefined;
- clearTimeout(websocket._closeTimer);
- if (
- websocket._receiver._writableState.finished ||
- websocket._receiver._writableState.errorEmitted
- ) {
- websocket.emitClose();
- } else {
- websocket._receiver.on('error', receiverOnFinish);
- websocket._receiver.on('finish', receiverOnFinish);
- }
- }
- function socketOnData(chunk) {
- if (!this[kWebSocket]._receiver.write(chunk)) {
- this.pause();
- }
- }
- function socketOnEnd() {
- const websocket = this[kWebSocket];
- websocket._readyState = WebSocket.CLOSING;
- websocket._receiver.end();
- this.end();
- }
- function socketOnError() {
- const websocket = this[kWebSocket];
- this.removeListener('error', socketOnError);
- this.on('error', NOOP);
- if (websocket) {
- websocket._readyState = WebSocket.CLOSING;
- this.destroy();
- }
- }
|