pax_global_header00006660000000000000000000000064130412060310014500gustar00rootroot0000000000000052 comment=49eab191cc2946e40bdee650e9bd0bb2384562a2 faye-websocket-node-0.11.1/000077500000000000000000000000001304120603100154135ustar00rootroot00000000000000faye-websocket-node-0.11.1/.gitignore000066400000000000000000000000151304120603100173770ustar00rootroot00000000000000node_modules faye-websocket-node-0.11.1/.npmignore000066400000000000000000000000711304120603100174100ustar00rootroot00000000000000.git .gitignore .npmignore .travis.yml node_modules spec faye-websocket-node-0.11.1/.travis.yml000066400000000000000000000003511304120603100175230ustar00rootroot00000000000000sudo: false language: node_js node_js: - "0.8" - "0.10" - "0.12" - "iojs-1" - "iojs-2" - "iojs-3" - "4" - "5" - "6" - "7" before_install: - '[ "${TRAVIS_NODE_VERSION}" != "0.8" ] || npm install -g npm@~1.4.0' faye-websocket-node-0.11.1/CHANGELOG.md000066400000000000000000000061041304120603100172250ustar00rootroot00000000000000### 0.11.1 / 2017-01-22 * Forcibly close the I/O stream after a timeout if the peer does not respond after calling `close()` ### 0.11.0 / 2016-02-24 * Introduce a `net` option to the `Client` class for setting things like, say, `servername` ### 0.10.0 / 2015-07-08 * Add the standard `code` and `reason` parameters to the `close` method ### 0.9.4 / 2015-03-08 * Don't send input to the driver before `start()` is called ### 0.9.3 / 2015-02-19 * Make sure the TCP socket is not left open when closing the connection ### 0.9.2 / 2014-12-21 * Only emit `error` once, and don't emit it after `close` ### 0.9.1 / 2014-12-18 * Check that all options to the WebSocket constructor are recognized ### 0.9.0 / 2014-12-13 * Allow protocol extensions to be passed into websocket-extensions ### 0.8.1 / 2014-11-12 * Send the correct hostname when upgrading a connection to TLS ### 0.8.0 / 2014-11-08 * Support connections via HTTP proxies * Close the connection cleanly if we're still waiting for a handshake response ### 0.7.3 / 2014-10-04 * Allow sockets to be closed when they are in any state other than `CLOSED` ### 0.7.2 / 2013-12-29 * Make sure the `close` event is emitted by clients on Node v0.10 ### 0.7.1 / 2013-12-03 * Support the `maxLength` websocket-driver option * Make the client emit `error` events on network errors ### 0.7.0 / 2013-09-09 * Allow the server to send custom headers with EventSource responses ### 0.6.1 / 2013-07-05 * Add `ca` option to the client for specifying certificate authorities * Start the server driver asynchronously so that `onopen` handlers can be added ### 0.6.0 / 2013-05-12 * Add support for custom headers ### 0.5.0 / 2013-05-05 * Extract the protocol handlers into the `websocket-driver` library * Support the Node streaming API ### 0.4.4 / 2013-02-14 * Emit the `close` event if TCP is closed before CLOSE frame is acked ### 0.4.3 / 2012-07-09 * Add `Connection: close` to EventSource response * Handle situations where `request.socket` is undefined ### 0.4.2 / 2012-04-06 * Add WebSocket error code `1011`. * Handle URLs with no path correctly by sending `GET /` ### 0.4.1 / 2012-02-26 * Treat anything other than a `Buffer` as a string when calling `send()` ### 0.4.0 / 2012-02-13 * Add `ping()` method to server-side `WebSocket` and `EventSource` * Buffer `send()` calls until the draft-76 handshake is complete * Fix HTTPS problems on Node 0.7 ### 0.3.1 / 2012-01-16 * Call `setNoDelay(true)` on `net.Socket` objects to reduce latency ### 0.3.0 / 2012-01-13 * Add support for `EventSource` connections ### 0.2.0 / 2011-12-21 * Add support for `Sec-WebSocket-Protocol` negotiation * Support `hixie-76` close frames and 75/76 ignored segments * Improve performance of HyBi parsing/framing functions * Decouple parsers from TCP and reduce write volume ### 0.1.2 / 2011-12-05 * Detect closed sockets on the server side when TCP connection breaks * Make `hixie-76` sockets work through HAProxy ### 0.1.1 / 2011-11-30 * Fix `addEventListener()` interface methods ### 0.1.0 / 2011-11-27 * Initial release, based on WebSocket components from Faye faye-websocket-node-0.11.1/CODE_OF_CONDUCT.md000066400000000000000000000002421304120603100202100ustar00rootroot00000000000000# 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). faye-websocket-node-0.11.1/README.md000066400000000000000000000304401304120603100166730ustar00rootroot00000000000000# faye-websocket * Travis CI build: [![Build status](https://secure.travis-ci.org/faye/faye-websocket-node.svg)](http://travis-ci.org/faye/faye-websocket-node) * Autobahn tests: [server](http://faye.jcoglan.com/autobahn/servers/), [client](http://faye.jcoglan.com/autobahn/clients/) This is a general-purpose WebSocket implementation extracted from the [Faye](http://faye.jcoglan.com) project. It provides classes for easily building WebSocket servers and clients in Node. It does not provide a server itself, but rather makes it easy to handle WebSocket connections within an existing [Node](https://nodejs.org/) application. It does not provide any abstraction other than the standard [WebSocket API](https://html.spec.whatwg.org/multipage/comms.html#network). It also provides an abstraction for handling [EventSource](https://html.spec.whatwg.org/multipage/comms.html#server-sent-events) connections, which are one-way connections that allow the server to push data to the client. They are based on streaming HTTP responses and can be easier to access via proxies than WebSockets. ## Installation ``` $ npm install faye-websocket ``` ## Handling WebSocket connections in Node You can handle WebSockets on the server side by listening for HTTP Upgrade requests, and creating a new socket for the request. This socket object exposes the usual WebSocket methods for receiving and sending messages. For example this is how you'd implement an echo server: ```js var WebSocket = require('faye-websocket'), http = require('http'); var server = http.createServer(); server.on('upgrade', function(request, socket, body) { if (WebSocket.isWebSocket(request)) { var ws = new WebSocket(request, socket, body); ws.on('message', function(event) { ws.send(event.data); }); ws.on('close', function(event) { console.log('close', event.code, event.reason); ws = null; }); } }); server.listen(8000); ``` `WebSocket` objects are also duplex streams, so you could replace the `ws.on('message', ...)` line with: ```js ws.pipe(ws); ``` Note that under certain circumstances (notably a draft-76 client connecting through an HTTP proxy), the WebSocket handshake will not be complete after you call `new WebSocket()` because the server will not have received the entire handshake from the client yet. In this case, calls to `ws.send()` will buffer the message in memory until the handshake is complete, at which point any buffered messages will be sent to the client. If you need to detect when the WebSocket handshake is complete, you can use the `onopen` event. If the connection's protocol version supports it, you can call `ws.ping()` to send a ping message and wait for the client's response. This method takes a message string, and an optional callback that fires when a matching pong message is received. It returns `true` if and only if a ping message was sent. If the client does not support ping/pong, this method sends no data and returns `false`. ```js ws.ping('Mic check, one, two', function() { // fires when pong is received }); ``` ## Using the WebSocket client The client supports both the plain-text `ws` protocol and the encrypted `wss` protocol, and has exactly the same interface as a socket you would use in a web browser. On the wire it identifies itself as `hybi-13`. ```js var WebSocket = require('faye-websocket'), ws = new WebSocket.Client('ws://www.example.com/'); ws.on('open', function(event) { console.log('open'); ws.send('Hello, world!'); }); ws.on('message', function(event) { console.log('message', event.data); }); ws.on('close', function(event) { console.log('close', event.code, event.reason); ws = null; }); ``` The WebSocket client also lets you inspect the status and headers of the handshake response via its `statusCode` and `headers` properties. To connect via a proxy, set the `proxy` option to the HTTP origin of the proxy, including any authorization information, custom headers and TLS config you require. Only the `origin` setting is required. ```js var ws = new WebSocket.Client('ws://www.example.com/', [], { proxy: { origin: 'http://username:password@proxy.example.com', headers: {'User-Agent': 'node'}, tls: {cert: fs.readFileSync('client.crt')} } }); ``` The `tls` value is an object that will be passed to [`tls.connect()`](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback). ## Subprotocol negotiation The WebSocket protocol allows peers to select and identify the application protocol to use over the connection. On the client side, you can set which protocols the client accepts by passing a list of protocol names when you construct the socket: ```js var ws = new WebSocket.Client('ws://www.example.com/', ['irc', 'amqp']); ``` On the server side, you can likewise pass in the list of protocols the server supports after the other constructor arguments: ```js var ws = new WebSocket(request, socket, body, ['irc', 'amqp']); ``` If the client and server agree on a protocol, both the client- and server-side socket objects expose the selected protocol through the `ws.protocol` property. ## Protocol extensions faye-websocket is based on the [websocket-extensions](https://github.com/faye/websocket-extensions-node) framework that allows extensions to be negotiated via the `Sec-WebSocket-Extensions` header. To add extensions to a connection, pass an array of extensions to the `:extensions` option. For example, to add [permessage-deflate](https://github.com/faye/permessage-deflate-node): ```js var deflate = require('permessage-deflate'); var ws = new WebSocket(request, socket, body, [], {extensions: [deflate]}); ``` ## Initialization options Both the server- and client-side classes allow an options object to be passed in at initialization time, for example: ```js var ws = new WebSocket(request, socket, body, protocols, options); var ws = new WebSocket.Client(url, protocols, options); ``` `protocols` is an array of subprotocols as described above, or `null`. `options` is an optional object containing any of these fields: * `extensions` - an array of [websocket-extensions](https://github.com/faye/websocket-extensions-node) compatible extensions, as described above * `headers` - an object containing key-value pairs representing HTTP headers to be sent during the handshake process * `maxLength` - the maximum allowed size of incoming message frames, in bytes. The default value is `2^26 - 1`, or 1 byte short of 64 MiB. * `ping` - an integer that sets how often the WebSocket should send ping frames, measured in seconds The client accepts some additional options: * `proxy` - settings for a proxy as described above * `net` - an object containing settings for the origin server that will be passed to [`net.connect()`](https://nodejs.org/api/net.html#net_socket_connect_options_connectlistener) * `tls` - an object containing TLS settings for the origin server, this will be passed to [`tls.connect()`](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback) * `ca` - (legacy) a shorthand for passing `{tls: {ca: value}}` ## WebSocket API Both server- and client-side `WebSocket` objects support the following API. * `on('open', function(event) {})` fires when the socket connection is established. Event has no attributes. * `on('message', function(event) {})` fires when the socket receives a message. Event has one attribute, `data`, which is either a `String` (for text frames) or a `Buffer` (for binary frames). * `on('error', function(event) {})` fires when there is a protocol error due to bad data sent by the other peer. This event is purely informational, you do not need to implement error recover. * `on('close', function(event) {})` fires when either the client or the server closes the connection. Event has two optional attributes, `code` and `reason`, that expose the status code and message sent by the peer that closed the connection. * `send(message)` accepts either a `String` or a `Buffer` and sends a text or binary message over the connection to the other peer. * `ping(message, function() {})` sends a ping frame with an optional message and fires the callback when a matching pong is received. * `close(code, reason)` closes the connection, sending the given status code and reason text, both of which are optional. * `version` is a string containing the version of the `WebSocket` protocol the connection is using. * `protocol` is a string (which may be empty) identifying the subprotocol the socket is using. ## Handling EventSource connections in Node EventSource connections provide a very similar interface, although because they only allow the server to send data to the client, there is no `onmessage` API. EventSource allows the server to push text messages to the client, where each message has an optional event-type and ID. ```js var WebSocket = require('faye-websocket'), EventSource = WebSocket.EventSource, http = require('http'); var server = http.createServer(); server.on('request', function(request, response) { if (EventSource.isEventSource(request)) { var es = new EventSource(request, response); console.log('open', es.url, es.lastEventId); // Periodically send messages var loop = setInterval(function() { es.send('Hello') }, 1000); es.on('close', function() { clearInterval(loop); es = null; }); } else { // Normal HTTP request response.writeHead(200, {'Content-Type': 'text/plain'}); response.end('Hello'); } }); server.listen(8000); ``` The `send` method takes two optional parameters, `event` and `id`. The default event-type is `'message'` with no ID. For example, to send a `notification` event with ID `99`: ```js es.send('Breaking News!', {event: 'notification', id: '99'}); ``` The `EventSource` object exposes the following properties: * `url` is a string containing the URL the client used to create the EventSource. * `lastEventId` is a string containing the last event ID received by the client. You can use this when the client reconnects after a dropped connection to determine which messages need resending. When you initialize an EventSource with ` new EventSource()`, you can pass configuration options after the `response` parameter. Available options are: * `headers` is an object containing custom headers to be set on the EventSource response. * `retry` is a number that tells the client how long (in seconds) it should wait after a dropped connection before attempting to reconnect. * `ping` is a number that tells the server how often (in seconds) to send 'ping' packets to the client to keep the connection open, to defeat timeouts set by proxies. The client will ignore these messages. For example, this creates a connection that allows access from any origin, pings every 15 seconds and is retryable every 10 seconds if the connection is broken: ```js var es = new EventSource(request, response, { headers: {'Access-Control-Allow-Origin': '*'}, ping: 15, retry: 10 }); ``` You can send a ping message at any time by calling `es.ping()`. Unlike WebSocket, the client does not send a response to this; it is merely to send some data over the wire to keep the connection alive. ## License (The MIT License) Copyright (c) 2010-2017 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 the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. faye-websocket-node-0.11.1/examples/000077500000000000000000000000001304120603100172315ustar00rootroot00000000000000faye-websocket-node-0.11.1/examples/autobahn_client.js000066400000000000000000000016461304120603100227350ustar00rootroot00000000000000var WebSocket = require('..').Client, deflate = require('permessage-deflate'), pace = require('pace'); var host = 'ws://localhost:9001', agent = encodeURIComponent('node-' + process.version), cases = 0, options = {extensions: [deflate]}; var socket = new WebSocket(host + '/getCaseCount'), url, progress; socket.onmessage = function(event) { console.log('Total cases to run: ' + event.data); cases = parseInt(event.data); progress = pace(cases); }; var runCase = function(n) { if (n > cases) { url = host + '/updateReports?agent=' + agent; socket = new WebSocket(url); socket.onclose = process.exit; return; } url = host + '/runCase?case=' + n + '&agent=' + agent; socket = new WebSocket(url, [], options); socket.pipe(socket); socket.on('close', function() { progress.op(); runCase(n + 1); }); }; socket.onclose = function() { runCase(1); }; faye-websocket-node-0.11.1/examples/client.js000066400000000000000000000014421304120603100210460ustar00rootroot00000000000000var WebSocket = require('..').Client, deflate = require('permessage-deflate'), fs = require('fs'); var url = process.argv[2], proxy = process.argv[3], ca = fs.readFileSync(__dirname + '/../spec/server.crt'), tls = {ca: ca}; var ws = new WebSocket(url, [], { proxy: {origin: proxy, headers: {'User-Agent': 'Echo'}, tls: tls}, tls: tls, headers: {Origin: 'http://faye.jcoglan.com'}, extensions: [deflate] }); ws.onopen = function() { console.log('[open]', ws.headers); ws.send('mic check'); }; ws.onclose = function(close) { console.log('[close]', close.code, close.reason); }; ws.onerror = function(error) { console.log('[error]', error.message); }; ws.onmessage = function(message) { console.log('[message]', message.data); }; faye-websocket-node-0.11.1/examples/haproxy.conf000066400000000000000000000005471304120603100216000ustar00rootroot00000000000000defaults mode http timeout client 5s timeout connect 5s timeout server 5s frontend all 0.0.0.0:3000 mode http timeout client 120s option forwardfor option http-server-close option http-pretend-keepalive default_backend sockets backend sockets balance uri depth 2 timeout server 120s server socket1 127.0.0.1:7000 faye-websocket-node-0.11.1/examples/proxy_server.js000066400000000000000000000003111304120603100223310ustar00rootroot00000000000000var ProxyServer = require('../spec/proxy_server'); var port = process.argv[2], secure = process.argv[3] === 'tls', proxy = new ProxyServer({debug: true, tls: secure}); proxy.listen(port); faye-websocket-node-0.11.1/examples/server.js000066400000000000000000000037061304120603100211030ustar00rootroot00000000000000var WebSocket = require('..'), deflate = require('permessage-deflate'), fs = require('fs'), http = require('http'), https = require('https'); var port = process.argv[2] || 7000, secure = process.argv[3] === 'tls', options = {extensions: [deflate], ping: 5}; var upgradeHandler = function(request, socket, head) { var ws = new WebSocket(request, socket, head, ['irc', 'xmpp'], options); console.log('[open]', ws.url, ws.version, ws.protocol, request.headers); ws.pipe(ws); ws.onclose = function(event) { console.log('[close]', event.code, event.reason); ws = null; }; }; var requestHandler = function(request, response) { if (!WebSocket.EventSource.isEventSource(request)) return staticHandler(request, response); var es = new WebSocket.EventSource(request, response), time = parseInt(es.lastEventId, 10) || 0; console.log('[open]', es.url, es.lastEventId); var loop = setInterval(function() { time += 1; es.send('Time: ' + time); setTimeout(function() { if (es) es.send('Update!!', {event: 'update', id: time}); }, 1000); }, 2000); fs.createReadStream(__dirname + '/haproxy.conf').pipe(es, {end: false}); es.onclose = function() { clearInterval(loop); console.log('[close]', es.url); es = null; }; }; var staticHandler = function(request, response) { var path = request.url; fs.readFile(__dirname + path, function(err, content) { var status = err ? 404 : 200; response.writeHead(status, {'Content-Type': 'text/html'}); response.write(content || 'Not found'); response.end(); }); }; var server = secure ? https.createServer({ key: fs.readFileSync(__dirname + '/../spec/server.key'), cert: fs.readFileSync(__dirname + '/../spec/server.crt') }) : http.createServer(); server.on('request', requestHandler); server.on('upgrade', upgradeHandler); server.listen(port); faye-websocket-node-0.11.1/examples/sse.html000066400000000000000000000015251304120603100207140ustar00rootroot00000000000000 EventSource test

EventSource test

faye-websocket-node-0.11.1/examples/ws.html000066400000000000000000000022111304120603100205440ustar00rootroot00000000000000 WebSocket test

WebSocket test

faye-websocket-node-0.11.1/lib/000077500000000000000000000000001304120603100161615ustar00rootroot00000000000000faye-websocket-node-0.11.1/lib/faye/000077500000000000000000000000001304120603100171055ustar00rootroot00000000000000faye-websocket-node-0.11.1/lib/faye/eventsource.js000066400000000000000000000072611304120603100220130ustar00rootroot00000000000000var Stream = require('stream').Stream, util = require('util'), driver = require('websocket-driver'), Headers = require('websocket-driver/lib/websocket/driver/headers'), API = require('./websocket/api'), EventTarget = require('./websocket/api/event_target'), Event = require('./websocket/api/event'); var EventSource = function(request, response, options) { this.writable = true; options = options || {}; this._stream = response.socket; this._ping = options.ping || this.DEFAULT_PING; this._retry = options.retry || this.DEFAULT_RETRY; var scheme = driver.isSecureRequest(request) ? 'https:' : 'http:'; this.url = scheme + '//' + request.headers.host + request.url; this.lastEventId = request.headers['last-event-id'] || ''; this.readyState = API.CONNECTING; var headers = new Headers(), self = this; if (options.headers) { for (var key in options.headers) headers.set(key, options.headers[key]); } if (!this._stream || !this._stream.writable) return; process.nextTick(function() { self._open() }); this._stream.setTimeout(0); this._stream.setNoDelay(true); var handshake = 'HTTP/1.1 200 OK\r\n' + 'Content-Type: text/event-stream\r\n' + 'Cache-Control: no-cache, no-store\r\n' + 'Connection: close\r\n' + headers.toString() + '\r\n' + 'retry: ' + Math.floor(this._retry * 1000) + '\r\n\r\n'; this._write(handshake); this._stream.on('drain', function() { self.emit('drain') }); if (this._ping) this._pingTimer = setInterval(function() { self.ping() }, this._ping * 1000); ['error', 'end'].forEach(function(event) { self._stream.on(event, function() { self.close() }); }); }; util.inherits(EventSource, Stream); EventSource.isEventSource = function(request) { if (request.method !== 'GET') return false; var accept = (request.headers.accept || '').split(/\s*,\s*/); return accept.indexOf('text/event-stream') >= 0; }; var instance = { DEFAULT_PING: 10, DEFAULT_RETRY: 5, _write: function(chunk) { if (!this.writable) return false; try { return this._stream.write(chunk, 'utf8'); } catch (e) { return false; } }, _open: function() { if (this.readyState !== API.CONNECTING) return; this.readyState = API.OPEN; var event = new Event('open'); event.initEvent('open', false, false); this.dispatchEvent(event); }, write: function(message) { return this.send(message); }, end: function(message) { if (message !== undefined) this.write(message); this.close(); }, send: function(message, options) { if (this.readyState > API.OPEN) return false; message = String(message).replace(/(\r\n|\r|\n)/g, '$1data: '); options = options || {}; var frame = ''; if (options.event) frame += 'event: ' + options.event + '\r\n'; if (options.id) frame += 'id: ' + options.id + '\r\n'; frame += 'data: ' + message + '\r\n\r\n'; return this._write(frame); }, ping: function() { return this._write(':\r\n\r\n'); }, close: function() { if (this.readyState > API.OPEN) return false; this.readyState = API.CLOSED; this.writable = false; if (this._pingTimer) clearInterval(this._pingTimer); if (this._stream) this._stream.end(); var event = new Event('close'); event.initEvent('close', false, false); this.dispatchEvent(event); return true; } }; for (var method in instance) EventSource.prototype[method] = instance[method]; for (var key in EventTarget) EventSource.prototype[key] = EventTarget[key]; module.exports = EventSource; faye-websocket-node-0.11.1/lib/faye/websocket.js000066400000000000000000000024241304120603100214330ustar00rootroot00000000000000// API references: // // * https://html.spec.whatwg.org/multipage/comms.html#network // * https://dom.spec.whatwg.org/#interface-eventtarget // * https://dom.spec.whatwg.org/#interface-event var util = require('util'), driver = require('websocket-driver'), API = require('./websocket/api'); var WebSocket = function(request, socket, body, protocols, options) { options = options || {}; this._stream = socket; this._driver = driver.http(request, {maxLength: options.maxLength, protocols: protocols}); var self = this; if (!this._stream || !this._stream.writable) return; if (!this._stream.readable) return this._stream.end(); var catchup = function() { self._stream.removeListener('data', catchup) }; this._stream.on('data', catchup); API.call(this, options); process.nextTick(function() { self._driver.start(); self._driver.io.write(body); }); }; util.inherits(WebSocket, API); WebSocket.isWebSocket = function(request) { return driver.isWebSocket(request); }; WebSocket.validateOptions = function(options, validKeys) { driver.validateOptions(options, validKeys); }; WebSocket.WebSocket = WebSocket; WebSocket.Client = require('./websocket/client'); WebSocket.EventSource = require('./eventsource'); module.exports = WebSocket; faye-websocket-node-0.11.1/lib/faye/websocket/000077500000000000000000000000001304120603100210735ustar00rootroot00000000000000faye-websocket-node-0.11.1/lib/faye/websocket/api.js000066400000000000000000000123341304120603100222050ustar00rootroot00000000000000var Stream = require('stream').Stream, util = require('util'), driver = require('websocket-driver'), EventTarget = require('./api/event_target'), Event = require('./api/event'); var API = function(options) { options = options || {}; driver.validateOptions(options, ['headers', 'extensions', 'maxLength', 'ping', 'proxy', 'tls', 'ca']); this.readable = this.writable = true; var headers = options.headers; if (headers) { for (var name in headers) this._driver.setHeader(name, headers[name]); } var extensions = options.extensions; if (extensions) { [].concat(extensions).forEach(this._driver.addExtension, this._driver); } this._ping = options.ping; this._pingId = 0; this.readyState = API.CONNECTING; this.bufferedAmount = 0; this.protocol = ''; this.url = this._driver.url; this.version = this._driver.version; var self = this; this._driver.on('open', function(e) { self._open() }); this._driver.on('message', function(e) { self._receiveMessage(e.data) }); this._driver.on('close', function(e) { self._beginClose(e.reason, e.code) }); this._driver.on('error', function(error) { self._emitError(error.message); }); this.on('error', function() {}); this._driver.messages.on('drain', function() { self.emit('drain'); }); if (this._ping) this._pingTimer = setInterval(function() { self._pingId += 1; self.ping(self._pingId.toString()); }, this._ping * 1000); this._configureStream(); if (!this._proxy) { this._stream.pipe(this._driver.io); this._driver.io.pipe(this._stream); } }; util.inherits(API, Stream); API.CONNECTING = 0; API.OPEN = 1; API.CLOSING = 2; API.CLOSED = 3; API.CLOSE_TIMEOUT = 30000; var instance = { write: function(data) { return this.send(data); }, end: function(data) { if (data !== undefined) this.send(data); this.close(); }, pause: function() { return this._driver.messages.pause(); }, resume: function() { return this._driver.messages.resume(); }, send: function(data) { if (this.readyState > API.OPEN) return false; if (!(data instanceof Buffer)) data = String(data); return this._driver.messages.write(data); }, ping: function(message, callback) { if (this.readyState > API.OPEN) return false; return this._driver.ping(message, callback); }, close: function(code, reason) { if (code === undefined) code = 1000; if (reason === undefined) reason = ''; if (code !== 1000 && (code < 3000 || code > 4999)) throw new Error("Failed to execute 'close' on WebSocket: " + "The code must be either 1000, or between 3000 and 4999. " + code + " is neither."); if (this.readyState !== API.CLOSED) this.readyState = API.CLOSING; this._driver.close(reason, code); var self = this; this._closeTimer = setTimeout(function() { self._beginClose('', 1006); }, API.CLOSE_TIMEOUT); }, _configureStream: function() { var self = this; this._stream.setTimeout(0); this._stream.setNoDelay(true); ['close', 'end'].forEach(function(event) { this._stream.on(event, function() { self._finalizeClose() }); }, this); this._stream.on('error', function(error) { self._emitError('Network error: ' + self.url + ': ' + error.message); self._finalizeClose(); }); }, _open: function() { if (this.readyState !== API.CONNECTING) return; this.readyState = API.OPEN; this.protocol = this._driver.protocol || ''; var event = new Event('open'); event.initEvent('open', false, false); this.dispatchEvent(event); }, _receiveMessage: function(data) { if (this.readyState > API.OPEN) return false; if (this.readable) this.emit('data', data); var event = new Event('message', {data: data}); event.initEvent('message', false, false); this.dispatchEvent(event); }, _emitError: function(message) { if (this.readyState >= API.CLOSING) return; var event = new Event('error', {message: message}); event.initEvent('error', false, false); this.dispatchEvent(event); }, _beginClose: function(reason, code) { if (this.readyState === API.CLOSED) return; this.readyState = API.CLOSING; this._closeParams = [reason, code]; if (this._stream) { this._stream.destroy(); if (!this._stream.readable) this._finalizeClose(); } }, _finalizeClose: function() { if (this.readyState === API.CLOSED) return; this.readyState = API.CLOSED; if (this._closeTimer) clearTimeout(this._closeTimer); if (this._pingTimer) clearInterval(this._pingTimer); if (this._stream) this._stream.end(); if (this.readable) this.emit('end'); this.readable = this.writable = false; var reason = this._closeParams ? this._closeParams[0] : '', code = this._closeParams ? this._closeParams[1] : 1006; var event = new Event('close', {code: code, reason: reason}); event.initEvent('close', false, false); this.dispatchEvent(event); } }; for (var method in instance) API.prototype[method] = instance[method]; for (var key in EventTarget) API.prototype[key] = EventTarget[key]; module.exports = API; faye-websocket-node-0.11.1/lib/faye/websocket/api/000077500000000000000000000000001304120603100216445ustar00rootroot00000000000000faye-websocket-node-0.11.1/lib/faye/websocket/api/event.js000066400000000000000000000007711304120603100233300ustar00rootroot00000000000000var Event = function(eventType, options) { this.type = eventType; for (var key in options) this[key] = options[key]; }; Event.prototype.initEvent = function(eventType, canBubble, cancelable) { this.type = eventType; this.bubbles = canBubble; this.cancelable = cancelable; }; Event.prototype.stopPropagation = function() {}; Event.prototype.preventDefault = function() {}; Event.CAPTURING_PHASE = 1; Event.AT_TARGET = 2; Event.BUBBLING_PHASE = 3; module.exports = Event; faye-websocket-node-0.11.1/lib/faye/websocket/api/event_target.js000066400000000000000000000011601304120603100246670ustar00rootroot00000000000000var Event = require('./event'); var EventTarget = { onopen: null, onmessage: null, onerror: null, onclose: null, addEventListener: function(eventType, listener, useCapture) { this.on(eventType, listener); }, removeEventListener: function(eventType, listener, useCapture) { this.removeListener(eventType, listener); }, dispatchEvent: function(event) { event.target = event.currentTarget = this; event.eventPhase = Event.AT_TARGET; if (this['on' + event.type]) this['on' + event.type](event); this.emit(event.type, event); } }; module.exports = EventTarget; faye-websocket-node-0.11.1/lib/faye/websocket/client.js000066400000000000000000000052341304120603100227130ustar00rootroot00000000000000var util = require('util'), net = require('net'), tls = require('tls'), url = require('url'), driver = require('websocket-driver'), API = require('./api'), Event = require('./api/event'); var DEFAULT_PORTS = {'http:': 80, 'https:': 443, 'ws:':80, 'wss:': 443}, SECURE_PROTOCOLS = ['https:', 'wss:']; var Client = function(_url, protocols, options) { options = options || {}; this.url = _url; this._driver = driver.client(this.url, {maxLength: options.maxLength, protocols: protocols}); ['open', 'error'].forEach(function(event) { this._driver.on(event, function() { self.headers = self._driver.headers; self.statusCode = self._driver.statusCode; }); }, this); var proxy = options.proxy || {}, endpoint = url.parse(proxy.origin || this.url), port = endpoint.port || DEFAULT_PORTS[endpoint.protocol], secure = SECURE_PROTOCOLS.indexOf(endpoint.protocol) >= 0, onConnect = function() { self._onConnect() }, netOptions = options.net || {}, originTLS = options.tls || {}, socketTLS = proxy.origin ? (proxy.tls || {}) : originTLS, self = this; netOptions.host = socketTLS.host = endpoint.hostname; netOptions.port = socketTLS.port = port; originTLS.ca = originTLS.ca || options.ca; socketTLS.servername = socketTLS.servername || endpoint.hostname; this._stream = secure ? tls.connect(socketTLS, onConnect) : net.connect(netOptions, onConnect); if (proxy.origin) this._configureProxy(proxy, originTLS); API.call(this, options); }; util.inherits(Client, API); Client.prototype._onConnect = function() { var worker = this._proxy || this._driver; worker.start(); }; Client.prototype._configureProxy = function(proxy, originTLS) { var uri = url.parse(this.url), secure = SECURE_PROTOCOLS.indexOf(uri.protocol) >= 0, self = this, name; this._proxy = this._driver.proxy(proxy.origin); if (proxy.headers) { for (name in proxy.headers) this._proxy.setHeader(name, proxy.headers[name]); } this._proxy.pipe(this._stream, {end: false}); this._stream.pipe(this._proxy); this._proxy.on('connect', function() { if (secure) { var options = {socket: self._stream, servername: uri.hostname}; for (name in originTLS) options[name] = originTLS[name]; self._stream = tls.connect(options); self._configureStream(); } self._driver.io.pipe(self._stream); self._stream.pipe(self._driver.io); self._driver.start(); }); this._proxy.on('error', function(error) { self._driver.emit('error', error); }); }; module.exports = Client; faye-websocket-node-0.11.1/package.json000066400000000000000000000015431304120603100177040ustar00rootroot00000000000000{ "name" : "faye-websocket" , "description" : "Standards-compliant WebSocket server and client" , "homepage" : "https://github.com/faye/faye-websocket-node" , "author" : "James Coglan (http://jcoglan.com/)" , "keywords" : ["websocket", "eventsource"] , "license" : "MIT" , "version" : "0.11.1" , "engines" : {"node": ">=0.8.0"} , "main" : "./lib/faye/websocket" , "dependencies" : {"websocket-driver": ">=0.5.1"} , "devDependencies" : {"jstest": "", "pace": "", "permessage-deflate": ""} , "scripts" : {"test": "jstest spec/runner.js"} , "repository" : { "type" : "git" , "url" : "git://github.com/faye/faye-websocket-node.git" } , "bugs" : "https://github.com/faye/faye-websocket-node/issues" } faye-websocket-node-0.11.1/spec/000077500000000000000000000000001304120603100163455ustar00rootroot00000000000000faye-websocket-node-0.11.1/spec/echo_server.js000066400000000000000000000014151304120603100212100ustar00rootroot00000000000000var fs = require('fs'), http = require('http'), https = require('https'); var WebSocket = require('../lib/faye/websocket'); var EchoServer = function(secure) { var server = secure ? https.createServer({ key: fs.readFileSync(__dirname + '/server.key'), cert: fs.readFileSync(__dirname + '/server.crt') }) : http.createServer(); server.on('upgrade', function(request, socket, head) { var ws = new WebSocket(request, socket, head, ["echo"]); ws.pipe(ws); }); this._httpServer = server; }; EchoServer.prototype.listen = function(port) { this._httpServer.listen(port); }; EchoServer.prototype.stop = function() { this._httpServer.close(); }; module.exports = EchoServer; faye-websocket-node-0.11.1/spec/faye/000077500000000000000000000000001304120603100172715ustar00rootroot00000000000000faye-websocket-node-0.11.1/spec/faye/websocket/000077500000000000000000000000001304120603100212575ustar00rootroot00000000000000faye-websocket-node-0.11.1/spec/faye/websocket/client_spec.js000066400000000000000000000162561304120603100241170ustar00rootroot00000000000000var Client = require('../../../lib/faye/websocket/client'), EchoServer = require('../../echo_server'), ProxyServer = require('../../proxy_server'), test = require('jstest').Test, fs = require('fs') var WebSocketSteps = test.asyncSteps({ server: function(port, secure, callback) { this._echoServer = new EchoServer(secure) this._echoServer.listen(port) process.nextTick(callback) }, stop: function(callback) { this._echoServer.stop() process.nextTick(callback) }, proxy: function(port, secure, callback) { this._proxyServer = new ProxyServer({tls: secure}) this._proxyServer.listen(port) process.nextTick(callback) }, stop_proxy: function(callback) { this._proxyServer.stop() process.nextTick(callback) }, open_socket: function(url, protocols, callback) { var done = false, self = this, tlsOptions = { ca: fs.readFileSync(__dirname + '/../../server.crt') }, resume = function(open) { if (done) return done = true self._open = open callback() } this._ws = new Client(url, protocols, { proxy: { origin: this.proxy_url, tls: tlsOptions }, tls: tlsOptions }) this._ws.onopen = function() { resume(true) } this._ws.onclose = function() { resume(false) } }, open_socket_and_close_it_fast: function(url, protocols, callback) { var self = this this._ws = new Client(url, protocols, { ca: fs.readFileSync(__dirname + '/../../server.crt') }) this._ws.onopen = function() { self._open = self._ever_opened = true } this._ws.onclose = function() { self._open = false } this._ws.close() callback() }, close_socket: function(callback) { var self = this this._ws.onclose = function() { self._open = false callback() } this._ws.close() }, check_open: function(status, headers, callback) { this.assert( this._open ) this.assertEqual( status, this._ws.statusCode ) for (var name in headers) this.assertEqual( headers[name], this._ws.headers[name.toLowerCase()] ) callback() }, check_closed: function(callback) { this.assert( !this._open ) callback() }, check_never_opened: function(callback) { this.assert( !this._ever_opened ) callback() }, check_readable: function(callback) { this.assert( this._ws.readable ) callback() }, check_not_readable: function(callback) { this.assert( ! this._ws.readable ) callback() }, check_protocol: function(protocol, callback) { this.assertEqual( protocol, this._ws.protocol ) callback() }, listen_for_message: function(callback) { var time = new Date().getTime(), self = this this._ws.addEventListener('message', function(message) { self._message = message.data }) var timer = setInterval(function() { if (self._message || new Date().getTime() - time > 3000) { clearInterval(timer) callback() } }, 100) }, send_message: function(message, callback) { var ws = this._ws setTimeout(function() { ws.send(message) }, 500) process.nextTick(callback) }, check_response: function(message, callback) { this.assertEqual( message, this._message ) callback() }, check_no_response: function(callback) { this.assert( !this._message ) callback() }, wait: function (ms, callback) { setTimeout(callback, ms) } }) test.describe("Client", function() { with(this) { include(WebSocketSteps) before(function() { this.protocols = ["foo", "echo"] this.plain_text_url = "ws://localhost:4180/bayeux" this.secure_url = "wss://localhost:4180/bayeux" this.port = 4180 this.plain_text_proxy_url = "http://localhost:4181" this.secure_text_proxy_url = "https://localhost:4181" this.proxy_port = 4181 }) sharedBehavior("socket client", function() { with(this) { it("can open a connection", function() { with(this) { open_socket(socket_url, protocols) check_open(101, {"Upgrade": "websocket"}) check_protocol("echo") }}) it("can close the connection", function() { with(this) { open_socket(socket_url, protocols) check_readable() close_socket() check_closed() check_not_readable() }}) describe("in the OPEN state", function() { with(this) { before(function() { with(this) { open_socket(socket_url, protocols) }}) it("can send and receive messages", function() { with(this) { send_message("I expect this to be echoed") listen_for_message() check_response("I expect this to be echoed") }}) it("sends numbers as strings", function() { with(this) { send_message(13) listen_for_message() check_response("13") }}) it("sends booleans as strings", function() { with(this) { send_message(false) listen_for_message() check_response("false") }}) it("sends arrays as strings", function() { with(this) { send_message([13,14,15]) listen_for_message() check_response("13,14,15") }}) }}) describe("in the CLOSED state", function() { with(this) { before(function() { with(this) { open_socket(socket_url, protocols) close_socket() }}) it("cannot send and receive messages", function() { with(this) { send_message("I expect this to be echoed") listen_for_message() check_no_response() }}) }}) it("can be closed before connecting", function() { with(this) { open_socket_and_close_it_fast(socket_url, protocols) wait(100) check_closed() check_never_opened() check_not_readable() }}) }}) sharedBehavior("socket server", function() { with(this) { describe("with a plain-text server", function() { with(this) { before(function() { this.socket_url = this.plain_text_url this.blocked_url = this.secure_url }) before(function() { this.server(this.port, false) }) after (function() { this.stop() }) behavesLike("socket client") }}) describe("with a secure server", function() { with(this) { before(function() { this.socket_url = this.secure_url this.blocked_url = this.plain_text_url }) before(function() { this.server(this.port, true) }) after (function() { this.stop() }) behavesLike("socket client") }}) }}) describe("with no proxy", function() { with(this) { behavesLike("socket server") }}) describe("with a proxy", function() { with(this) { before(function() { this.proxy_url = this.plain_text_proxy_url }) before(function() { this.proxy(this.proxy_port, false) }) after (function() { this.stop_proxy() }) behavesLike("socket server") }}) describe("with a secure proxy", function() { with(this) { before(function() { this.proxy_url = this.secure_text_proxy_url }) before(function() { this.proxy(this.proxy_port, true) }) after (function() { this.stop_proxy() }) behavesLike("socket server") }}) }}) faye-websocket-node-0.11.1/spec/proxy_server.js000066400000000000000000000042631304120603100214570ustar00rootroot00000000000000var fs = require('fs'), http = require('http'), https = require('https'), net = require('net'), url = require('url'); var AGENTS = {'http:': http, 'https:': https}, PORTS = {'http:': 80, 'https:': 443}; var ProxyServer = function(options) { var proxy = options.tls ? https.createServer({ key: fs.readFileSync(__dirname + '/server.key'), cert: fs.readFileSync(__dirname + '/server.crt') }) : http.createServer(); options = options || {}; var onRequest = function(request, response) { if (options.debug) console.log(request.method, request.url, request.headers); var uri = url.parse(request.url), agent = AGENTS[uri.protocol], headers = {}; for (var key in request.headers) { if (key.split('-')[0] !== 'proxy') headers[key] = request.headers[key]; } var backend = agent.request({ method: request.method, host: uri.hostname, port: uri.port || PORTS[uri.protocol], path: uri.path, headers: headers, rejectUnauthorized: false }); request.pipe(backend); backend.on('response', function(resp) { if (options.debug) console.log(resp.statusCode, resp.headers); response.writeHead(resp.statusCode, resp.headers); resp.pipe(response); }); }; var onConnect = function(request, frontend, body) { var parts = request.url.split(':'), backend = net.connect(parts[1], parts[0]); frontend.pipe(backend); backend.pipe(frontend); backend.on('connect', function() { frontend.write('HTTP/1.1 200 OK\r\n\r\n'); }); if (!options.debug) return; console.log(request.method, request.url, request.headers); frontend.on('data', function(data) { console.log('I', data) }); backend.on( 'data', function(data) { console.log('O', data) }); }; proxy.on('request', onRequest); proxy.on('connect', onConnect); proxy.on('upgrade', onConnect); this._proxy = proxy; }; ProxyServer.prototype.listen = function(port) { this._proxy.listen(port); }; ProxyServer.prototype.stop = function() { this._proxy.close(); }; module.exports = ProxyServer; faye-websocket-node-0.11.1/spec/runner.js000066400000000000000000000000501304120603100202070ustar00rootroot00000000000000require('./faye/websocket/client_spec') faye-websocket-node-0.11.1/spec/server.crt000066400000000000000000000013511304120603100203650ustar00rootroot00000000000000-----BEGIN CERTIFICATE----- MIIB+TCCAWICCQDr4AAn4L7GeDANBgkqhkiG9w0BAQUFADBBMQswCQYDVQQGEwJV SzEPMA0GA1UECBMGTG9uZG9uMQ0wCwYDVQQKEwRGYXllMRIwEAYDVQQDEwlsb2Nh bGhvc3QwHhcNMTYxMjI5MTEyNTA2WhcNMTcxMjI5MTEyNTA2WjBBMQswCQYDVQQG EwJVSzEPMA0GA1UECBMGTG9uZG9uMQ0wCwYDVQQKEwRGYXllMRIwEAYDVQQDEwls b2NhbGhvc3QwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBALqXLvze/oYkelPw uT+eI2bkk6QDyB9h3pRW5m53F4W7rZybRT+NvzlTWU27K6XxbMA6V50hVU7evIgk Mh3vsFIXNFHFW0Li/hZdmgE7Tle853cxB9uVI3WtP5ju14m2knCPKVvbhsy089cb ptD8fO2CXm+54AsCUkAheUSVTU11AgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAA9Vn zJ5gyhLnVdcJnvBzBvGebRvfCf91HbZdbQ+J8ySRqNr8KYc1RZg1xAmSnpc7/Uvu QWh2/Z/zVLnHvhtTHngSbNHX2FGBYS0Ticrvc2sV1l+MYubPfG/k6fyW0hZenY6R Dur664VQ7whZ+l2Nf2Gj1beM7iBNehiWu1bPpW8= -----END CERTIFICATE----- faye-websocket-node-0.11.1/spec/server.key000066400000000000000000000015731304120603100203730ustar00rootroot00000000000000-----BEGIN RSA PRIVATE KEY----- MIICXgIBAAKBgQC6ly783v6GJHpT8Lk/niNm5JOkA8gfYd6UVuZudxeFu62cm0U/ jb85U1lNuyul8WzAOledIVVO3ryIJDId77BSFzRRxVtC4v4WXZoBO05XvOd3MQfb lSN1rT+Y7teJtpJwjylb24bMtPPXG6bQ/Hztgl5vueALAlJAIXlElU1NdQIDAQAB AoGBAKwv476bEgo8E17u4CSjDExhVxWeH8lGCZ6eats5r01MGjRQ3SB+8B44mkqv FOJ33kGuFTf9kLnNtfF0ZYNWs0AaDZ6c2Bfom3VtP3YzoTfZHcyHRNCt00Pp79Pt Gc0HSeq3SvsnJZxgtQOItEvzbaaSFETefJ2iJZrLymDlh5XBAkEA5rbb+J/r37mX 56ZH9SG4cHhF2EIn86NgihRMMhcHWkuGDM0j0H1jaKwDkLtvGqacXpiiiUAgl0eo AZZ4+XnNXQJBAM8KWL4q3/IPH/hQgx8mJeefwS19LLUQsq62phuWiOiPrirvLSfK yokreRpOkwt1CRIeI5kauKtZ+7ycJQRv5vkCQQCfYnZGpVxTO6j4jIQrkbcUY9KE mvd0tkpsOaeF9yjKNWCPGW0DjIwPdL4lz4bq120xYKrwvI+HUyZ6qlQ6rO21AkEA nAU1COGwb24cbnjlxtRtnhXScqAwz6XssSKtHH8dXvvfiTVCNwloBWSAV2W9A9ZH ZqLVuqvbXC1sOh8E+koFqQJAWynSNx9Hm1zLRp9XtpE80ZBytBL/BR9We6cg0HB+ c1cv3HhZj3gyN197k33/sok+1wY4HgxAimFhgoxamdM/zg== -----END RSA PRIVATE KEY-----