Compare commits

...

39 Commits

Author SHA1 Message Date
James Coglan c4494ff88a Bump version to 0.6.5. 2016-05-20 08:41:04 +01:00
James Coglan cfb2a86838 Test on Node 6.0. 2016-04-30 13:08:02 +01:00
James Coglan 6a92cacf62 Apply masking to messages once the payload has been placed in the frame buffer rather than mutating the original message. 2016-04-27 22:28:58 +01:00
James Coglan 2be829546b Bump version to 0.6.4. 2016-01-07 08:58:29 +00:00
James Coglan 7f3bb13b5c In draft-75/76, convert all non-string values to strings before sending. 2016-01-06 23:20:47 +00:00
James Coglan ffa0aa3a8f Convert numbers to strings when sending frames.
In draft-75/76, passing a number to text() or frame() results in the
sender allocating a buffer of that size and sending it to the other
peer, leaking random blocks of memory.

In hybi, a call to text(), binary() or ping() with a number will fail,
because the input is expected to be a buffer and so an internal method
call fails.

Both kinds of driver now convert numbers to strings, which is what
browsers do with calls to send().
2016-01-06 23:12:44 +00:00
James Coglan 7c64c35c74 Create CODE_OF_CONDUCT.md. 2015-11-08 12:16:08 +00:00
James Coglan 10481b81db Bump version to 0.6.3. 2015-11-06 22:16:36 +00:00
James Coglan 5b3c8131c4 Test on Node 5. 2015-11-05 21:22:37 +00:00
James Coglan b0b0d69ce4 Throw a more helpful error if a client driver is created with an invalid URL. 2015-10-17 21:44:36 +01:00
James Coglan 3461e0187b Run tests on major versions of iojs and node 4. 2015-10-17 12:58:10 +01:00
James Coglan 5b59d0fcd8 Use the modulo operator rather than Math.floor() to check whether the draft-76 keys are legit. 2015-10-02 21:35:22 +01:00
James Coglan 68990a260b Close the connection if a draft-76 client sends a Sec-WebSocket-Key header where the numeric value is a non-integer multiple of the number of spaces. 2015-10-01 23:47:15 +01:00
James Coglan fa8b82d424 Bump version to 0.6.2. 2015-07-18 17:40:03 +01:00
James Coglan 89e2a7da82 Emit a protocol error when a closing frame has a 1-byte payload. 2015-07-17 22:05:26 +01:00
James Coglan 70ef5440c4 Emit close code 1000 if the closing frame does not contain one. 2015-07-15 18:04:02 +01:00
James Coglan c84cce9a1f Bump version to 0.6.1. 2015-07-13 20:13:20 +01:00
James Coglan c8e5f1eb78 A few stylistic tweaks. 2015-07-11 23:26:49 +01:00
James Coglan eb5e39e7e3 Standardise the words used to refer to chunks of parser input. 2015-07-10 22:37:54 +01:00
James Coglan a95f68080e Use the buffer.{read,write}UInt{16,32}BE functions to parse and write numbers rather than implementing such things ourselves. 2015-07-10 20:01:44 +01:00
James Coglan 7a1cb15b8c Bump version to 0.6.0. 2015-07-08 20:17:01 +01:00
James Coglan 14937dd365 Emit an error event *after* setting the ready state to 3. 2015-07-08 20:14:14 +01:00
James Coglan 780dd331fe The 'connect' event should emit a ConnectEvent object. 2015-07-07 21:33:15 +01:00
James Coglan 4a3d51cc5b Incorporate StreamReader into Draft75 so that it retains input and recovers safely from exceptions in event listeners. 2015-07-07 21:30:06 +01:00
James Coglan ed17186354 In the Hybi driver, perform parser state changes before validating and emitting events. This protects the parser against errors thrown by event listeners. 2015-07-07 20:36:30 +01:00
James Coglan 1df1293456 Change stage in the Base.shutdown() method to that all parsers stop processing input. 2015-07-04 21:07:34 +01:00
James Coglan d901d3e48d If an event listener emits an error, close the connection with code 1011. 2015-07-04 20:54:22 +01:00
James Coglan a49cd60cb7 Document that on() *adds* a callback, rather than *setting* one, i.e. it does not remove any prior callbacks. 2015-07-04 19:31:36 +01:00
James Coglan 4dd872f0ef Add the pong() command to the documentation. 2015-07-04 18:50:55 +01:00
Victor Gama 90b8c9d23a Add tests to others socket states 2015-07-04 18:34:00 +01:00
Victor Gama c3ac50931e Implement unit tests for pong method 2015-07-04 18:33:59 +01:00
Victor Gama 5f6873ebc0 Ensure message is always defined 2015-07-04 18:33:59 +01:00
Victor Gama 309b5651a7 Implement 'pong' command to hybi.js 2015-07-04 18:33:59 +01:00
James Coglan 1cc0f33e1c Update the changelog for 0.5.4. 2015-03-29 23:13:10 +01:00
James Coglan b273147f0c Replace 'iff' with 'if and only if'. 2015-03-28 19:44:10 +00:00
James Coglan d1796bef12 Use require('..') to import this module in examples. 2015-03-28 09:47:59 +00:00
James Coglan 0034f5fe19 Fail the connection when the server receives an invalid Sec-WebSocket-Extensions header. 2015-03-26 08:51:34 +00:00
James Coglan 09f638893e Bump version to 0.5.4. 2015-03-12 12:59:53 +00:00
James Coglan 8a0235ef51 Don't send a close frame in response to receiving one, if we already sent a close frame. 2015-03-12 12:58:43 +00:00
19 changed files with 476 additions and 159 deletions
+7 -1
View File
@@ -1,3 +1,4 @@
sudo: false
language: node_js
node_js:
@@ -5,7 +6,12 @@ node_js:
- "0.8"
- "0.10"
- "0.12"
- "iojs"
- "iojs-1"
- "iojs-2"
- "iojs-3"
- "4"
- "5"
- "6"
before_install:
- '[ "${TRAVIS_NODE_VERSION}" = "0.6" ] && npm conf set strict-ssl false || true'
+40 -3
View File
@@ -1,3 +1,37 @@
### 0.6.5 / 2016-05-20
* Don't mutate buffers passed in by the application when masking
### 0.6.4 / 2016-01-07
* If a number is given as input for a frame payload, send it as a string
### 0.6.3 / 2015-11-06
* Reject draft-76 handshakes if their Sec-WebSocket-Key headers are invalid
* Throw a more helpful error if a client is created with an invalid URL
### 0.6.2 / 2015-07-18
* When the peer sends a close frame with no error code, emit 1000
### 0.6.1 / 2015-07-13
* Use the `buffer.{read,write}UInt{16,32}BE` methods for reading/writing numbers
to buffers rather than including duplicate logic for this
### 0.6.0 / 2015-07-08
* Allow the parser to recover cleanly if event listeners raise an error
* Add a `pong` method for sending unsolicited pong frames
### 0.5.4 / 2015-03-29
* Don't emit extra close frames if we receive a close frame after we already
sent one
* Fail the connection when the driver receives an invalid
`Sec-WebSocket-Extensions` header
### 0.5.3 / 2015-02-22
* Don't treat incoming data as WebSocket frames if a client driver is closed
@@ -6,7 +40,8 @@
### 0.5.2 / 2015-02-19
* Fix compatibility with the HTTP parser on io.js
* Use `websocket-extensions` to make sure messages and close frames are kept in order
* Use `websocket-extensions` to make sure messages and close frames are kept in
order
* Don't emit multiple `error` events
### 0.5.1 / 2014-12-18
@@ -32,7 +67,8 @@
### 0.3.4 / 2014-05-08
* Don't hold memory-leaking references to I/O buffers after they have been parsed
* Don't hold memory-leaking references to I/O buffers after they have been
parsed
### 0.3.3 / 2014-04-24
@@ -40,7 +76,8 @@
### 0.3.2 / 2013-12-29
* Expand `maxLength` to cover sequences of continuation frames and `draft-{75,76}`
* Expand `maxLength` to cover sequences of continuation frames and
`draft-{75,76}`
* Decrease default maximum frame buffer size to 64MB
* Stop parsing when the protocol enters a failure mode, to save CPU cycles
+4
View File
@@ -0,0 +1,4 @@
# Code of Conduct
All projects under the [Faye](https://github.com/faye) umbrella are covered by
the [Code of Conduct](https://github.com/faye/code-of-conduct).
+16 -7
View File
@@ -21,7 +21,7 @@ this module up to some I/O object, it will do all of this for you:
* Deal with proxies that defer delivery of the draft-76 handshake body
* Notify you when the socket is open and closed and when messages arrive
* Recombine fragmented messages
* Dispatch text, binary, ping and close frames
* Dispatch text, binary, ping, pong and close frames
* Manage the socket-closing handshake process
* Automatically reply to ping frames with a matching pong
* Apply masking to messages sent by the client
@@ -259,11 +259,11 @@ the `driver.io` stream.
#### `driver.on('open', function(event) {})`
Sets the callback to execute when the socket becomes open.
Adds a callback to execute when the socket becomes open.
#### `driver.on('message', function(event) {})`
Sets the callback to execute when a message is received. `event` will have a
Adds a callback to execute when a message is received. `event` will have a
`data` attribute containing either a string in the case of a text message or a
`Buffer` in the case of a binary message.
@@ -272,13 +272,13 @@ which emits strings for text messages and buffers for binary messages.
#### `driver.on('error', function(event) {})`
Sets the callback to execute when a protocol error occurs due to the other peer
Adds a callback to execute when a protocol error occurs due to the other peer
sending an invalid byte sequence. `event` will have a `message` attribute
describing the error.
#### `driver.on('close', function(event) {})`
Sets the callback to execute when the socket becomes closed. The `event` object
Adds a callback to execute when the socket becomes closed. The `event` object
has `code` and `reason` attributes.
#### `driver.addExtension(extension)`
@@ -298,7 +298,7 @@ when the headers are serialized and sent.
Initiates the protocol by sending the handshake - either the response for a
server-side driver or the request for a client-side one. This should be the
first method you invoke. Returns `true` iff a handshake was sent.
first method you invoke. Returns `true` if and only if a handshake was sent.
#### `driver.parse(string)`
@@ -330,6 +330,15 @@ callback are both optional. If a callback is given, it will be invoked when the
socket receives a pong frame whose content matches `string`. Returns `false` if
frames can no longer be sent, or if the driver does not support ping/pong.
#### `driver.pong(string = '')`
Sends a pong frame over the socket, queueing it if necessary. `string` is
optional. Returns `false` if frames can no longer be sent, or if the driver does
not support ping/pong.
You don't need to call this when a ping frame is received; pings are replied to
automatically by the driver. This method is for sending unsolicited pongs.
#### `driver.close()`
Initiates the closing handshake if the socket is still open. For drivers with no
@@ -354,7 +363,7 @@ using the `Sec-WebSocket-Protocol` mechanism. This value becomes available after
(The MIT License)
Copyright (c) 2010-2015 James Coglan
Copyright (c) 2010-2016 James Coglan
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
+1 -1
View File
@@ -1,5 +1,5 @@
var net = require('net'),
websocket = require('../lib/websocket/driver'),
websocket = require('..'),
deflate = require('permessage-deflate');
var server = net.createServer(function(connection) {
+10 -2
View File
@@ -3,13 +3,15 @@
var Emitter = require('events').EventEmitter,
util = require('util'),
streams = require('../streams'),
Headers = require('./headers');
Headers = require('./headers'),
Reader = require('./stream_reader');
var Base = function(request, url, options) {
Emitter.call(this);
Base.validateOptions(options || {}, ['maxLength', 'masking', 'requireMasking', 'protocols']);
this._request = request;
this._reader = new Reader();
this._options = options || {};
this._maxLength = this._options.maxLength || this.MAX_LENGTH;
this._headers = new Headers();
@@ -77,7 +79,9 @@ var instance = {
start: function() {
if (this.readyState !== 0) return false;
this._write(this._handshakeResponse());
var response = this._handshakeResponse();
if (!response) return false;
this._write(response);
if (this._stage !== -1) this._open();
return true;
},
@@ -94,6 +98,10 @@ var instance = {
return false;
},
pong: function() {
return false;
},
close: function(reason, code) {
if (this.readyState !== 1) return false;
this.readyState = 3;
+9 -4
View File
@@ -20,6 +20,9 @@ var Client = function(_url, options) {
var uri = url.parse(this.url),
auth = uri.auth && new Buffer(uri.auth, 'utf8').toString('base64');
if (this.VALID_PROTOCOLS.indexOf(uri.protocol) < 0)
throw new Error(this.url + ' is not a valid WebSocket URL');
this._pathname = (uri.pathname || '/') + (uri.search || '');
this._headers.set('Host', uri.host);
@@ -41,6 +44,8 @@ Client.generateKey = function() {
};
var instance = {
VALID_PROTOCOLS: ['ws:', 'wss:'],
proxy: function(origin, options) {
return new Proxy(this, origin, options);
},
@@ -52,11 +57,11 @@ var instance = {
return true;
},
parse: function(data) {
parse: function(chunk) {
if (this.readyState === 3) return;
if (this.readyState > 0) return Hybi.prototype.parse.call(this, data);
if (this.readyState > 0) return Hybi.prototype.parse.call(this, chunk);
this._http.parse(data);
this._http.parse(chunk);
if (!this._http.isComplete()) return;
this._validateHandshake();
@@ -79,8 +84,8 @@ var instance = {
_failHandshake: function(message) {
message = 'Error during WebSocket handshake: ' + message;
this.emit('error', new Error(message));
this.readyState = 3;
this.emit('error', new Error(message));
this.emit('close', new Base.CloseEvent(this.ERRORS.protocol_error, message));
},
+27 -25
View File
@@ -5,7 +5,7 @@ var Base = require('./base'),
var Draft75 = function(request, url, options) {
Base.apply(this, arguments);
this._stage = 0;
this._stage = 0;
this.version = 'hixie-75';
this._headers.set('Upgrade', 'WebSocket');
@@ -23,46 +23,46 @@ var instance = {
return true;
},
parse: function(buffer) {
parse: function(chunk) {
if (this.readyState > 1) return;
var data, message, value;
for (var i = 0, n = buffer.length; i < n; i++) {
data = buffer[i];
this._reader.put(chunk);
this._reader.eachByte(function(octet) {
var message;
switch (this._stage) {
case -1:
this._body.push(data);
this._body.push(octet);
this._sendHandshakeBody();
break;
case 0:
this._parseLeadingByte(data);
this._parseLeadingByte(octet);
break;
case 1:
value = (data & 0x7F);
this._length = value + 128 * this._length;
this._length = (octet & 0x7F) + 128 * this._length;
if (this._closing && this._length === 0) {
return this.close();
}
else if ((0x80 & data) !== 0x80) {
else if ((octet & 0x80) !== 0x80) {
if (this._length === 0) {
this._stage = 0;
}
else {
this._skipped = 0;
this._stage = 2;
this._stage = 2;
}
}
break;
case 2:
if (data === 0xFF) {
if (octet === 0xFF) {
this._stage = 0;
message = new Buffer(this._buffer).toString('utf8', 0, this._buffer.length);
this.emit('message', new Base.MessageEvent(message));
this._stage = 0;
}
else {
if (this._length) {
@@ -70,25 +70,27 @@ var instance = {
if (this._skipped === this._length)
this._stage = 0;
} else {
this._buffer.push(data);
this._buffer.push(octet);
if (this._buffer.length > this._maxLength) return this.close();
}
}
break;
}
}
}, this);
},
frame: function(data) {
if (this.readyState === 0) return this._queue([data]);
frame: function(buffer) {
if (this.readyState === 0) return this._queue([buffer]);
if (this.readyState > 1) return false;
var buffer = new Buffer(data, 'utf8'),
frame = new Buffer(buffer.length + 2);
if (typeof buffer !== 'string') buffer = buffer.toString();
var payload = new Buffer(buffer, 'utf8'),
frame = new Buffer(payload.length + 2);
frame[0] = 0x00;
frame[buffer.length + 1] = 0xFF;
buffer.copy(frame, 1);
frame[payload.length + 1] = 0xFF;
payload.copy(frame, 1);
this._write(frame);
return true;
@@ -101,15 +103,15 @@ var instance = {
return new Buffer(headers.join('\r\n'), 'utf8');
},
_parseLeadingByte: function(data) {
if ((0x80 & data) === 0x80) {
_parseLeadingByte: function(octet) {
if ((octet & 0x80) === 0x80) {
this._length = 0;
this._stage = 1;
this._stage = 1;
} else {
delete this._length;
delete this._skipped;
this._buffer = [];
this._stage = 2;
this._stage = 2;
}
}
};
+27 -21
View File
@@ -14,14 +14,6 @@ var spacesInKey = function(key) {
return key.match(/ /g).length;
};
var bigEndian = function(number) {
var string = '';
[24, 16, 8, 0].forEach(function(offset) {
string += String.fromCharCode(number >> offset & 0xFF);
});
return string;
};
var Draft76 = function(request, url, options) {
Draft75.apply(this, arguments);
@@ -57,6 +49,24 @@ var instance = {
},
_handshakeResponse: function() {
var headers = this._request.headers,
key1 = headers['sec-websocket-key1'],
number1 = numberFromKey(key1),
spaces1 = spacesInKey(key1),
key2 = headers['sec-websocket-key2'],
number2 = numberFromKey(key2),
spaces2 = spacesInKey(key2);
if (number1 % spaces1 !== 0 || number2 % spaces2 !== 0) {
this.emit('error', new Error('Client sent invalid Sec-WebSocket-Key headers'));
this.close();
return null;
}
this._keyValues = [number1 / spaces1, number2 / spaces2];
var start = 'HTTP/1.1 101 WebSocket Protocol Handshake',
headers = [start, this._headers.toString(), ''];
@@ -65,19 +75,15 @@ var instance = {
_handshakeSignature: function() {
if (this._body.length < this.BODY_SIZE) return null;
var body = new Buffer(this._body.slice(0, this.BODY_SIZE));
var headers = this._request.headers,
key1 = headers['sec-websocket-key1'],
value1 = numberFromKey(key1) / spacesInKey(key1),
key2 = headers['sec-websocket-key2'],
value2 = numberFromKey(key2) / spacesInKey(key2),
md5 = crypto.createHash('md5');
var md5 = crypto.createHash('md5'),
buffer = new Buffer(8 + this.BODY_SIZE);
md5.update(bigEndian(value1));
md5.update(bigEndian(value2));
md5.update(body.toString('binary'));
buffer.writeUInt32BE(this._keyValues[0], 0);
buffer.writeUInt32BE(this._keyValues[1], 4);
new Buffer(this._body).copy(buffer, 8, 0, this.BODY_SIZE);
md5.update(buffer);
return new Buffer(md5.digest('binary'), 'binary');
},
@@ -94,9 +100,9 @@ var instance = {
this.parse(this._body.slice(this.BODY_SIZE));
},
_parseLeadingByte: function(data) {
if (data !== 0xFF)
return Draft75.prototype._parseLeadingByte.call(this, data);
_parseLeadingByte: function(octet) {
if (octet !== 0xFF)
return Draft75.prototype._parseLeadingByte.call(this, octet);
this._closing = true;
this._length = 0;
+73 -73
View File
@@ -5,14 +5,12 @@ var crypto = require('crypto'),
Extensions = require('websocket-extensions'),
Base = require('./base'),
Frame = require('./hybi/frame'),
Message = require('./hybi/message'),
Reader = require('./hybi/stream_reader');
Message = require('./hybi/message');
var Hybi = function(request, url, options) {
Base.apply(this, arguments);
this._extensions = new Extensions();
this._reader = new Reader();
this._stage = 0;
this._masking = this._options.masking;
this._protocols = this._options.protocols || [];
@@ -62,14 +60,13 @@ Hybi.generateAccept = function(key) {
Hybi.GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
var instance = {
BYTE: 255,
FIN: 128,
MASK: 128,
RSV1: 64,
RSV2: 32,
RSV3: 16,
OPCODE: 15,
LENGTH: 127,
FIN: 0x80,
MASK: 0x80,
RSV1: 0x40,
RSV2: 0x20,
RSV3: 0x10,
OPCODE: 0x0F,
LENGTH: 0x7F,
OPCODES: {
continuation: 0,
@@ -84,8 +81,6 @@ var instance = {
MESSAGE_OPCODES: [0, 1, 2],
OPENING_OPCODES: [1, 2],
TWO_POWERS: [0, 1, 2, 3, 4, 5, 6, 7].map(function(n) { return Math.pow(2, 8 * n) }),
ERRORS: {
normal_closure: 1000,
going_away: 1001,
@@ -99,6 +94,7 @@ var instance = {
},
ERROR_CODES: [1000, 1001, 1002, 1003, 1007, 1008, 1009, 1010, 1011],
DEFAULT_ERROR_CODE: 1000,
MIN_RESERVED_ERROR: 3000,
MAX_RESERVED_ERROR: 4999,
@@ -110,8 +106,8 @@ var instance = {
return true;
},
parse: function(data) {
this._reader.put(data);
parse: function(chunk) {
this._reader.put(chunk);
var buffer = true;
while (buffer) {
switch (this._stage) {
@@ -133,16 +129,16 @@ var instance = {
case 3:
buffer = this._reader.read(4);
if (buffer) {
this._frame.maskingKey = buffer;
this._stage = 4;
this._frame.maskingKey = buffer;
}
break;
case 4:
buffer = this._reader.read(this._frame.length);
if (buffer) {
this._emitFrame(buffer);
this._stage = 0;
this._emitFrame(buffer);
}
break;
@@ -169,6 +165,12 @@ var instance = {
return this.frame(message, 'ping');
},
pong: function(message) {
if (this.readyState > 1) return false;
message = message ||'';
return this.frame(message, 'pong');
},
close: function(reason, code) {
reason = reason || '';
code = code || this.ERRORS.normal_closure;
@@ -186,27 +188,27 @@ var instance = {
}
},
frame: function(data, type, code) {
if (this.readyState <= 0) return this._queue([data, type, code]);
frame: function(buffer, type, code) {
if (this.readyState <= 0) return this._queue([buffer, type, code]);
if (this.readyState > 2) return false;
if (data instanceof Array) data = new Buffer(data);
if (buffer instanceof Array) buffer = new Buffer(buffer);
if (typeof buffer === 'number') buffer = buffer.toString();
var message = new Message(),
isText = (typeof data === 'string'),
payload, buffer;
isText = (typeof buffer === 'string'),
payload, copy;
message.rsv1 = message.rsv2 = message.rsv3 = false;
message.opcode = this.OPCODES[type || (isText ? 'text' : 'binary')];
payload = isText ? new Buffer(data, 'utf8') : data;
payload = isText ? new Buffer(buffer, 'utf8') : buffer;
if (code) {
buffer = payload;
payload = new Buffer(2 + buffer.length);
payload[0] = ~~(code / 256) & this.BYTE;
payload[1] = code & this.BYTE;
buffer.copy(payload, 2);
copy = payload;
payload = new Buffer(2 + copy.length);
payload.writeUInt16BE(code, 0);
copy.copy(payload, 2);
}
message.data = payload;
@@ -243,7 +245,6 @@ var instance = {
header = (length <= 125) ? 2 : (length <= 65535 ? 4 : 10),
offset = header + (frame.masked ? 4 : 0),
buffer = new Buffer(offset + length),
BYTE = this.BYTE,
masked = frame.masked ? this.MASK : 0;
buffer[0] = (frame.final ? this.FIN : 0) |
@@ -256,32 +257,30 @@ var instance = {
buffer[1] = masked | length;
} else if (length <= 65535) {
buffer[1] = masked | 126;
buffer[2] = ~~(length / 256);
buffer[3] = length & BYTE;
buffer.writeUInt16BE(length, 2);
} else {
buffer[1] = masked | 127;
buffer[2] = ~~(length / Math.pow(2, 56)) & BYTE;
buffer[3] = ~~(length / Math.pow(2, 48)) & BYTE;
buffer[4] = ~~(length / Math.pow(2, 40)) & BYTE;
buffer[5] = ~~(length / Math.pow(2, 32)) & BYTE;
buffer[6] = ~~(length / Math.pow(2, 24)) & BYTE;
buffer[7] = ~~(length / Math.pow(2, 16)) & BYTE;
buffer[8] = ~~(length / Math.pow(2, 8)) & BYTE;
buffer[9] = length & BYTE;
buffer.writeUInt32BE(Math.floor(length / 0x100000000), 2);
buffer.writeUInt32BE(length % 0x100000000, 6);
}
frame.payload.copy(buffer, offset);
if (frame.masked) {
frame.maskingKey.copy(buffer, header);
Hybi.mask(frame.payload, frame.maskingKey).copy(buffer, offset);
} else {
frame.payload.copy(buffer, offset);
Hybi.mask(buffer, frame.maskingKey, offset);
}
this._write(buffer);
},
_handshakeResponse: function() {
var extensions = this._extensions.generateResponse(this._request.headers['sec-websocket-extensions']);
try {
var extensions = this._extensions.generateResponse(this._request.headers['sec-websocket-extensions']);
} catch (e) {
return this._fail('protocol_error', e.message);
}
if (extensions) this._headers.set('Sec-WebSocket-Extensions', extensions);
var start = 'HTTP/1.1 101 Switching Protocols',
@@ -290,37 +289,41 @@ var instance = {
return new Buffer(headers.join('\r\n'), 'utf8');
},
_shutdown: function(code, reason) {
_shutdown: function(code, reason, error) {
delete this._frame;
delete this._message;
this.readyState = 2;
this._stage = 5;
var sendCloseFrame = (this.readyState === 1);
this.readyState = 2;
this._extensions.close(function() {
this.frame(reason, 'close', code);
if (sendCloseFrame) this.frame(reason, 'close', code);
this.readyState = 3;
if (error) this.emit('error', new Error(reason));
this.emit('close', new Base.CloseEvent(code, reason));
}, this);
},
_fail: function(type, message) {
if (this.readyState > 1) return;
this.emit('error', new Error(message));
this._shutdown(this.ERRORS[type], message);
this._shutdown(this.ERRORS[type], message, true);
},
_parseOpcode: function(data) {
_parseOpcode: function(octet) {
var rsvs = [this.RSV1, this.RSV2, this.RSV3].map(function(rsv) {
return (data & rsv) === rsv;
return (octet & rsv) === rsv;
});
var frame = this._frame = new Frame();
frame.final = (data & this.FIN) === this.FIN;
frame.final = (octet & this.FIN) === this.FIN;
frame.rsv1 = rsvs[0];
frame.rsv2 = rsvs[1];
frame.rsv3 = rsvs[2];
frame.opcode = (data & this.OPCODE);
frame.opcode = (octet & this.OPCODE);
this._stage = 1;
if (!this._extensions.validFrameRsv(frame))
return this._fail('protocol_error',
@@ -336,38 +339,35 @@ var instance = {
if (this._message && this.OPENING_OPCODES.indexOf(frame.opcode) >= 0)
return this._fail('protocol_error', 'Received new data frame but previous continuous frame is unfinished');
this._stage = 1;
},
_parseLength: function(data) {
_parseLength: function(octet) {
var frame = this._frame;
frame.masked = (data & this.MASK) === this.MASK;
if (this._requireMasking && !frame.masked)
return this._fail('unacceptable', 'Received unmasked frame but masking is required');
frame.length = (data & this.LENGTH);
frame.masked = (octet & this.MASK) === this.MASK;
frame.length = (octet & this.LENGTH);
if (frame.length >= 0 && frame.length <= 125) {
if (!this._checkFrameLength()) return;
this._stage = frame.masked ? 3 : 4;
if (!this._checkFrameLength()) return;
} else {
frame.lengthBytes = (frame.length === 126 ? 2 : 8);
this._stage = 2;
frame.lengthBytes = (frame.length === 126 ? 2 : 8);
}
if (this._requireMasking && !frame.masked)
return this._fail('unacceptable', 'Received unmasked frame but masking is required');
},
_parseExtendedLength: function(buffer) {
var frame = this._frame;
frame.length = this._getInteger(buffer);
frame.length = this._readUInt(buffer);
this._stage = frame.masked ? 3 : 4;
if (this.MESSAGE_OPCODES.indexOf(frame.opcode) < 0 && frame.length > 125)
return this._fail('protocol_error', 'Received control frame having too long payload: ' + frame.length);
if (!this._checkFrameLength()) return;
this._stage = frame.masked ? 3 : 4;
},
_checkFrameLength: function() {
@@ -405,7 +405,7 @@ var instance = {
return this._emitMessage(this._message);
if (opcode === this.OPCODES.close) {
code = (payload.length >= 2) ? 256 * payload[0] + payload[1] : null;
code = (payload.length >= 2) ? payload.readUInt16BE(0) : null;
reason = (payload.length > 2) ? this._encode(payload.slice(2)) : null;
if (!(payload.length === 0) &&
@@ -416,7 +416,7 @@ var instance = {
if (payload.length > 125 || (payload.length > 2 && !reason))
code = this.ERRORS.protocol_error;
this._shutdown(code, reason || '');
this._shutdown(code || this.DEFAULT_ERROR_CODE, reason || '');
}
if (opcode === this.OPCODES.ping) {
@@ -460,11 +460,11 @@ var instance = {
return buffer.toString('utf8', 0, buffer.length);
},
_getInteger: function(bytes) {
var number = 0;
for (var i = 0, n = bytes.length; i < n; i++)
number += bytes[i] * this.TWO_POWERS[n - 1 - i];
return number;
_readUInt: function(buffer) {
if (buffer.length === 2) return buffer.readUInt16BE(0);
return buffer.readUInt32BE(0) * 0x100000000 +
buffer.readUInt32BE(4);
}
};
+2 -1
View File
@@ -3,6 +3,7 @@
var Stream = require('stream').Stream,
url = require('url'),
util = require('util'),
Base = require('./base'),
Headers = require('./headers'),
HttpParser = require('../http_parser');
@@ -69,7 +70,7 @@ var instance = {
this.headers = this._http.headers;
if (this.statusCode === 200) {
this.emit('connect');
this.emit('connect', new Base.ConnectEvent());
} else {
var message = "Can't establish a connection to the server at " + this._origin.href;
this.emit('error', new Error(message));
+3 -3
View File
@@ -21,10 +21,10 @@ var instance = {
this.on('error', function() {});
},
parse: function(data) {
if (this._delegate) return this._delegate.parse(data);
parse: function(chunk) {
if (this._delegate) return this._delegate.parse(chunk);
this._http.parse(data);
this._http.parse(chunk);
if (!this._http.isComplete()) return;
this.method = this._http.method;
@@ -3,6 +3,7 @@
var StreamReader = function() {
this._queue = [];
this._queueSize = 0;
this._offset = 0;
};
StreamReader.prototype.put = function(buffer) {
@@ -15,13 +16,15 @@ StreamReader.prototype.put = function(buffer) {
StreamReader.prototype.read = function(length) {
if (length > this._queueSize) return null;
if (length === 0) return new Buffer(0);
var queue = this._queue,
first = queue[0],
buffer;
this._queueSize -= length;
var queue = this._queue,
remain = length,
first = queue[0],
buffers, buffer;
if (first.length >= length) {
this._queueSize -= length;
if (first.length === length) {
return queue.shift();
} else {
@@ -30,10 +33,8 @@ StreamReader.prototype.read = function(length) {
return buffer;
}
}
var remain = length, buffers;
for (var i=0, n = queue.length; i < n; i++) {
for (var i = 0, n = queue.length; i < n; i++) {
if (remain < queue[i].length) break;
remain -= queue[i].length;
}
@@ -43,10 +44,26 @@ StreamReader.prototype.read = function(length) {
buffers.push(queue[0].slice(0, remain));
queue[0] = queue[0].slice(remain);
}
this._queueSize -= length;
return this._concat(buffers, length);
};
StreamReader.prototype.eachByte = function(callback, context) {
var buffer, n, index;
while (this._queue.length > 0) {
buffer = this._queue[0];
n = buffer.length;
while (this._offset < n) {
index = this._offset;
this._offset += 1;
callback.call(context, buffer[index]);
}
this._offset = 0;
this._queue.shift();
}
};
StreamReader.prototype._concat = function(buffers, length) {
if (Buffer.concat) return Buffer.concat(buffers, length);
+4 -4
View File
@@ -87,13 +87,13 @@ HttpParser.prototype.isComplete = function() {
return this._complete;
};
HttpParser.prototype.parse = function(data) {
HttpParser.prototype.parse = function(chunk) {
var offset = (version < 6) ? 1 : 0,
consumed = this._parser.execute(data, 0, data.length) + offset;
consumed = this._parser.execute(chunk, 0, chunk.length) + offset;
if (this._complete)
this.body = (consumed < data.length)
? data.slice(consumed)
this.body = (consumed < chunk.length)
? chunk.slice(consumed)
: new Buffer(0);
};
+3 -3
View File
@@ -1,11 +1,11 @@
{ "name" : "websocket-driver"
, "description" : "WebSocket protocol handler with pluggable I/O"
, "homepage" : "http://github.com/faye/websocket-driver-node"
, "homepage" : "https://github.com/faye/websocket-driver-node"
, "author" : "James Coglan <jcoglan@gmail.com> (http://jcoglan.com/)"
, "keywords" : ["websocket"]
, "license" : "MIT"
, "version" : "0.5.3"
, "version" : "0.6.5"
, "engines" : {"node": ">=0.6.0"}
, "main" : "./lib/websocket/driver"
, "dependencies" : {"websocket-extensions": ">=0.1.1"}
@@ -17,5 +17,5 @@
, "url" : "git://github.com/faye/websocket-driver-node.git"
}
, "bugs" : "http://github.com/faye/websocket-driver-node/issues"
, "bugs" : "https://github.com/faye/websocket-driver-node/issues"
}
+11 -1
View File
@@ -109,6 +109,16 @@ test.describe("Client", function() { with(this) {
}})
}})
describe("with an invalid URL", function() { with(this) {
define("url", function() { return "stream.wikimedia.org/rc" })
it("throws an error", function() { with(this) {
var message
try { driver() } catch (e) { message = e.message }
assertEqual( "stream.wikimedia.org/rc is not a valid WebSocket URL", message )
}})
}})
describe("with custom headers", function() { with(this) {
before(function() { with(this) {
driver().setHeader("User-Agent", "Chrome")
@@ -184,7 +194,7 @@ test.describe("Client", function() { with(this) {
}})
it("emits a 'connect' event when the proxy connects", function() { with(this) {
expect(proxy, "emit").given("connect")
expect(proxy, "emit").given("connect", anything())
expect(proxy, "emit").given("close")
expect(proxy, "emit").given("end")
proxy.write(new Buffer("HTTP/1.1 200 OK\r\n\r\n"))
+27
View File
@@ -42,6 +42,28 @@ test.describe("draft-75", function() { with(this) {
driver().parse([0x6c, 0x6f, 0xff])
assertEqual( "Hello", message )
}})
describe("when a message listener throws an error", function() { with(this) {
before(function() { with(this) {
this.messages = []
driver().on("message", function(msg) {
messages.push(msg.data)
throw new Error("an error")
})
}})
it("is not trapped by the parser", function() { with(this) {
var buffer = [0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff]
assertThrows(Error, function() { driver().parse(buffer) })
}})
it("parses text frames without dropping input", function() { with(this) {
try { driver().parse([0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff, 0x00, 0x57]) } catch (e) {}
try { driver().parse([0x6f, 0x72, 0x6c, 0x64, 0xff]) } catch (e) {}
assertEqual( ["Hello", "World"], messages )
}})
}})
}})
describe("frame", function() { with(this) {
@@ -55,6 +77,11 @@ test.describe("draft-75", function() { with(this) {
assertEqual( [0x00, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf, 0xff], collector().bytes )
}})
it("converts numbers to strings", function() { with(this) {
driver().frame(50)
assertEqual( [0x00, 0x35, 0x30, 0xff], collector().bytes )
}})
it("returns true", function() { with(this) {
assertEqual( true, driver().frame("lol") )
}})
+32
View File
@@ -34,6 +34,7 @@ test.describe("Draft76", function() { with(this) {
var self = this
this._driver.on('open', function(e) { self.open = true })
this._driver.on('message', function(e) { self.message += e.data })
this._driver.on('error', function(e) { self.error = e })
this._driver.on('close', function(e) { self.close = true })
this._driver.io.pipe(this.collector())
this._driver.io.write(this.body())
@@ -81,6 +82,37 @@ test.describe("Draft76", function() { with(this) {
driver().start()
assertEqual( "hixie-76", driver().version )
}})
describe("with an invalid key header", function() { with(this) {
before(function() { with(this) {
request().headers["sec-websocket-key1"] = "2 L785 8o% s9Sy9@V. 4<1P5"
}})
it("writes a closing frame to the socket", function() { with(this) {
expect(driver().io, "emit").given("data", buffer([0xff, 0x00]))
driver().start()
}})
it("does not trigger the onopen event", function() { with(this) {
driver().start()
assertEqual( false, open )
}})
it("triggers the onerror event", function() { with(this) {
driver().start()
assertEqual( "Client sent invalid Sec-WebSocket-Key headers", error.message )
}})
it("triggers the onclose event", function() { with(this) {
driver().start()
assertEqual( true, close )
}})
it("changes the state to closed", function() { with(this) {
driver().start()
assertEqual( "closed", driver().getState() )
}})
}})
}})
describe("frame", function() { with(this) {
+153
View File
@@ -79,6 +79,37 @@ test.describe("Hybi", function() { with(this) {
}})
}})
describe("with invalid extensions", function() { with(this) {
before(function() { with(this) {
request().headers["sec-websocket-extensions"] = "x-webkit- -frame"
}})
it("does not write a handshake", function() { with(this) {
expect(driver().io, "emit").exactly(0)
driver().start()
}})
it("does not trigger the onopen event", function() { with(this) {
driver().start()
assertEqual( false, open )
}})
it("triggers the onerror event", function() { with(this) {
driver().start()
assertEqual( "Invalid Sec-WebSocket-Extensions header: x-webkit- -frame", error.message )
}})
it("triggers the onclose event", function() { with(this) {
driver().start()
assertEqual( [1002, "Invalid Sec-WebSocket-Extensions header: x-webkit- -frame"], close )
}})
it("changes the state to closed", function() { with(this) {
driver().start()
assertEqual( "closed", driver().getState() )
}})
}})
describe("with custom headers", function() { with(this) {
before(function() { with(this) {
driver().setHeader("Authorization", "Bearer WAT")
@@ -160,6 +191,30 @@ test.describe("Hybi", function() { with(this) {
}})
}})
describe("pong", function() { with(this) {
it("does not write to the socket", function() { with(this) {
expect(driver().io, "emit").exactly(0)
driver().pong()
}})
it("returns true", function() { with(this) {
assertEqual( true, driver().pong() )
}})
it("queues the pong until the handshake has been sent", function() { with(this) {
expect(driver().io, "emit").given("data", buffer(
"HTTP/1.1 101 Switching Protocols\r\n" +
"Upgrade: websocket\r\n" +
"Connection: Upgrade\r\n" +
"Sec-WebSocket-Accept: JdiiuafpBKRqD7eol0y4vJDTsTs=\r\n" +
"\r\n"))
expect(driver().io, "emit").given("data", buffer([0x8a, 0]))
driver().pong()
driver().start()
}})
}})
describe("close", function() { with(this) {
it("does not write anything to the socket", function() { with(this) {
expect(driver().io, "emit").exactly(0)
@@ -330,6 +385,28 @@ test.describe("Hybi", function() { with(this) {
driver().parse([0x89, 0x04, 0x4f, 0x48, 0x41, 0x49])
assertEqual( [0x8a, 0x04, 0x4f, 0x48, 0x41, 0x49], collector().bytes )
}})
describe("when a message listener throws an error", function() { with(this) {
before(function() { with(this) {
this.messages = []
driver().on("message", function(msg) {
messages.push(msg.data)
throw new Error("an error")
})
}})
it("is not trapped by the parser", function() { with(this) {
var buffer = [0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f]
assertThrows(Error, function() { driver().parse(buffer) })
}})
it("parses unmasked text frames without dropping input", function() { with(this) {
try { driver().parse([0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x81, 0x05]) } catch (e) {}
try { driver().parse([0x57, 0x6f, 0x72, 0x6c, 0x64]) } catch (e) {}
assertEqual( ["Hello", "World"], messages )
}})
}})
}})
describe("frame", function() { with(this) {
@@ -343,6 +420,11 @@ test.describe("Hybi", function() { with(this) {
assertEqual( [0x82, 0x03, 0x48, 0x65, 0x6c], collector().bytes )
}})
it("converts numbers to strings", function() { with(this) {
driver().frame(50)
assertEqual( [0x81, 0x02, 0x35, 0x30], collector().bytes )
}})
it("encodes multibyte characters correctly", function() { with(this) {
driver().frame("Apple = ")
assertEqual( [0x81, 0x0b, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf], collector().bytes )
@@ -375,6 +457,11 @@ test.describe("Hybi", function() { with(this) {
assertEqual( [0x89, 0x09, 0x6d, 0x69, 0x63, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b], collector().bytes )
}})
it("converts numbers to strings", function() { with(this) {
driver().ping(50)
assertEqual( [0x89, 0x02, 0x35, 0x30], collector().bytes )
}})
it("returns true", function() { with(this) {
assertEqual( true, driver().ping() )
}})
@@ -394,6 +481,17 @@ test.describe("Hybi", function() { with(this) {
}})
}})
describe("pong", function() { with(this) {
it("writes a pong frame to the socket", function() { with(this) {
driver().pong("mic check")
assertEqual([0x8a, 0x09, 0x6d, 0x69, 0x63, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b], collector().bytes)
}})
it("returns true", function() { with(this) {
assertEqual(true, driver().pong())
}})
}})
describe("close", function() { with(this) {
it("writes a close frame to the socket", function() { with(this) {
driver().close("<%= reasons %>", 1003)
@@ -467,6 +565,17 @@ test.describe("Hybi", function() { with(this) {
}})
}})
describe("pong", function() { with(this) {
it("does not write to the socket", function() { with(this) {
expect(driver().io, "emit").exactly(0)
driver().pong()
}})
it("returns false", function() { with(this) {
assertEqual( false, driver().pong() )
}})
}})
describe("close", function() { with(this) {
it("does not write to the socket", function() { with(this) {
expect(driver().io, "emit").exactly(0)
@@ -490,6 +599,39 @@ test.describe("Hybi", function() { with(this) {
it("changes the state to closed", function() { with(this) {
assertEqual( "closed", driver().getState() )
}})
it("does not write another close frame", function() { with(this) {
expect(driver().io, "emit").exactly(0)
this.driver().parse([0x88, 0x04, 0x03, 0xe9, 0x4f, 0x4b])
}})
}})
describe("receiving a close frame with a too-short payload", function() { with(this) {
before(function() {
this.driver().parse([0x88, 0x01, 0x03])
})
it("triggers the onclose event with a protocol error", function() { with(this) {
assertEqual( [1002, ""], close )
}})
it("changes the state to closed", function() { with(this) {
assertEqual( "closed", driver().getState() )
}})
}})
describe("receiving a close frame with no code", function() { with(this) {
before(function() { with(this) {
this.driver().parse([0x88, 0x00])
}})
it("triggers the onclose event with code 1000", function() { with(this) {
assertEqual( [1000, ""], close )
}})
it("changes the state to closed", function() { with(this) {
assertEqual( "closed", driver().getState() )
}})
}})
}})
@@ -522,6 +664,17 @@ test.describe("Hybi", function() { with(this) {
}})
}})
describe("pong", function() { with(this) {
it("does not write to the socket", function() { with(this) {
expect(driver().io, "emit").exactly(0)
driver().pong()
}})
it("returns false", function() { with(this) {
assertEqual( false, driver().pong() )
}})
}})
describe("close", function() { with(this) {
it("does not write to the socket", function() { with(this) {
expect(driver().io, "emit").exactly(0)