rocket-js 0.0.2 → 0.0.3

data/src/vendor/web-socket-js/README.txt

@@ -1,109 +0,0 @@
-* How to try
-
-Assuming you have Web server (e.g. Apache) running at http://example.com/ .
-
-- Download web_socket.rb from:
-  http://github.com/gimite/web-socket-ruby/tree/master
-- Run sample Web Socket server (echo server) in example.com with: (#1)
-  $ ruby web-socket-ruby/samples/echo_server.rb example.com 10081
-- If your server already provides socket policy file at port 843, modify the file to allow access to port 10081. Otherwise you can skip this step. See below for details.
-- Publish the web-socket-js directory with your Web server (e.g. put it in ~/public_html).
-- Change ws://localhost:10081 to ws://example.com:10081 in sample.html.
-- Open sample.html in your browser.
-- After "onopen" is shown, input something, click [Send] and confirm echo back.
-
-#1: First argument of echo_server.rb means that it accepts Web Socket connection from HTML pages in example.com.
-
-
-* Troubleshooting
-
-If it doesn't work, try these:
-
-1. Try Chrome and Firefox 3.x.
-- It doesn't work on Chrome:
--- It's likely an issue of your code or the server. Debug your code as usual e.g. using console.log.
-- It works on Chrome but it doesn't work on Firefox:
--- It's likely an issue of web-socket-js specific configuration (e.g. 3 and 4 below).
-- It works on both Chrome and Firefox, but it doesn't work on your browser:
--- Check "Supported environment" section below. Your browser may not be supported by web-socket-js.
-
-2. Add this line before your code:
-  WEB_SOCKET_DEBUG = true;
-and use Developer Tools (Chrome/Safari) or Firebug (Firefox) to see if console.log outputs any errors.
-
-3. Make sure you do NOT open your HTML page as local file e.g. file:///.../sample.html. web-socket-js doesn't work on local file. Open it via Web server e.g. http:///.../sample.html.
-
-4. If you are NOT using web-socket-ruby as your WebSocket server, you need to place Flash socket policy file on your server. See "Flash socket policy file" section below for details.
-
-5. Check if sample.html bundled with web-socket-js works.
-
-6. Make sure the port used for WebSocket (10081 in example above) is not blocked by your server/client's firewall.
-
-7. Install debugger version of Flash Player available here to see Flash errors:
-http://www.adobe.com/support/flashplayer/downloads.html
-
-
-* Supported environments
-
-It should work on:
-- Google Chrome 4 or later (just uses native implementation)
-- Firefox 3.x, Internet Explorer 8 + Flash Player 9 or later
-
-It may or may not work on other browsers such as Safari, Opera or IE 6. Patch for these browsers are appreciated, but I will not work on fixing issues specific to these browsers by myself.
-
-
-* Flash socket policy file
-
-This implementation uses Flash's socket, which means that your server must provide Flash socket policy file to declare the server accepts connections from Flash.
-
-If you use web-socket-ruby available at
-http://github.com/gimite/web-socket-ruby/tree/master
-, you don't need anything special, because web-socket-ruby handles Flash socket policy file request. But if you already provide socket policy file at port 843, you need to modify the file to allow access to Web Socket port, because it precedes what web-socket-ruby provides.
-
-If you use other Web Socket server implementation, you need to provide socket policy file yourself. See
-http://www.lightsphere.com/dev/articles/flash_socket_policy.html
-for details and sample script to run socket policy file server. node.js implementation is available here:
-http://github.com/LearnBoost/Socket.IO-node/blob/master/lib/socket.io/transports/flashsocket.js
-
-Actually, it's still better to provide socket policy file at port 843 even if you use web-socket-ruby. Flash always try to connect to port 843 first, so providing the file at port 843 makes startup faster.
-
-
-* Cookie considerations
-
-Cookie is sent if Web Socket host is the same as the origin of JavaScript. Otherwise it is not sent, because I don't know way to send right Cookie (which is Cookie of the host of Web Socket, I heard).
-
-Note that it's technically possible that client sends arbitrary string as Cookie and any other headers (by modifying this library for example) once you place Flash socket policy file in your server. So don't trust Cookie and other headers if you allow connection from untrusted origin.
-
-
-* Proxy considerations
-
-The WebSocket spec (http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol) specifies instructions for User Agents to support proxied connections by implementing the HTTP CONNECT method.
-
-The AS3 Socket class doesn't implement this mechanism, which renders it useless for the scenarios where the user trying to open a socket is behind a proxy. 
-
-The class RFC2817Socket (by Christian Cantrell) effectively lets us implement this, as long as the proxy settings are known and provided by the interface that instantiates the WebSocket. As such, if you want to support proxied conncetions, you'll have to supply this information to the WebSocket constructor when Flash is being used. One way to go about it would be to ask the user for proxy settings information if the initial connection fails.
-
-
-* How to host HTML file and SWF file in different domains
-
-By default, HTML file and SWF file must be in the same domain. You can follow steps below to allow hosting them in different domain.
-
-WARNING: If you use the method below, HTML files in ANY domains can send arbitrary TCP data to your WebSocket server, regardless of configuration in Flash socket policy file. Arbitrary TCP data means that they can even fake request headers including Origin and Cookie.
-
-- Unzip WebSocketMainInsecure.zip to extract WebSocketMainInsecure.swf.
-- Put WebSocketMainInsecure.swf on your server, instead of WebSocketMain.swf.
-- In JavaScript, set WEB_SOCKET_SWF_LOCATION to URL of your WebSocketMainInsecure.swf.
-
-
-* How to build WebSocketMain.swf
-
-Install Flex 4 SDK:
-http://opensource.adobe.com/wiki/display/flexsdk/Download+Flex+4
-
-$ cd flash-src
-$ ./build.sh
-
-
-* License
-
-New BSD License.

data/src/vendor/web-socket-js/flash-src/WebSocket.as

@@ -1,473 +0,0 @@
-// Copyright: Hiroshi Ichikawa <http://gimite.net/en/>
-// License: New BSD License
-// Reference: http://dev.w3.org/html5/websockets/
-// Reference: http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76
-
-package {
-
-import flash.display.*;
-import flash.events.*;
-import flash.external.*;
-import flash.net.*;
-import flash.system.*;
-import flash.utils.*;
-import mx.core.*;
-import mx.controls.*;
-import mx.events.*;
-import mx.utils.*;
-import com.adobe.net.proxies.RFC2817Socket;
-import com.hurlant.crypto.tls.TLSSocket;
-import com.hurlant.crypto.tls.TLSConfig;
-import com.hurlant.crypto.tls.TLSEngine;
-import com.hurlant.crypto.tls.TLSSecurityParameters;
-import com.gsolo.encryption.MD5;
-
-[Event(name="message", type="flash.events.Event")]
-[Event(name="open", type="flash.events.Event")]
-[Event(name="close", type="flash.events.Event")]
-[Event(name="error", type="flash.events.Event")]
-[Event(name="stateChange", type="WebSocketStateEvent")]
-public class WebSocket extends EventDispatcher {
-  
-  private static var CONNECTING:int = 0;
-  private static var OPEN:int = 1;
-  private static var CLOSING:int = 2;
-  private static var CLOSED:int = 3;
-  
-  private var rawSocket:Socket;
-  private var tlsSocket:TLSSocket;
-  private var tlsConfig:TLSConfig;
-  private var socket:Socket;
-  private var main:WebSocketMain;
-  private var url:String;
-  private var scheme:String;
-  private var host:String;
-  private var port:uint;
-  private var path:String;
-  private var origin:String;
-  private var protocol:String;
-  private var buffer:ByteArray = new ByteArray();
-  private var dataQueue:Array;
-  private var headerState:int = 0;
-  private var readyState:int = CONNECTING;
-  private var bufferedAmount:int = 0;
-  private var headers:String;
-  private var noiseChars:Array;
-  private var expectedDigest:String;
-
-  public function WebSocket(
-      main:WebSocketMain, url:String, protocol:String,
-      proxyHost:String = null, proxyPort:int = 0,
-      headers:String = null) {
-    this.main = main;
-    initNoiseChars();
-    this.url = url;
-    var m:Array = url.match(/^(\w+):\/\/([^\/:]+)(:(\d+))?(\/.*)?$/);
-    if (!m) main.fatal("SYNTAX_ERR: invalid url: " + url);
-    this.scheme = m[1];
-    this.host = m[2];
-    this.port = parseInt(m[4] || "80");
-    this.path = m[5] || "/";
-    this.origin = main.getOrigin();
-    this.protocol = protocol;
-    // if present and not the empty string, headers MUST end with \r\n
-    // headers should be zero or more complete lines, for example
-    // "Header1: xxx\r\nHeader2: yyyy\r\n"
-    this.headers = headers;
-    
-    if (proxyHost != null && proxyPort != 0){
-      if (scheme == "wss") {
-        main.fatal("wss with proxy is not supported");
-      }
-      var proxySocket:RFC2817Socket = new RFC2817Socket();
-      proxySocket.setProxyInfo(proxyHost, proxyPort);
-      proxySocket.addEventListener(ProgressEvent.SOCKET_DATA, onSocketData);
-      rawSocket = socket = proxySocket;
-    } else {
-      rawSocket = new Socket();
-      if (scheme == "wss") {
-        tlsConfig= new TLSConfig(TLSEngine.CLIENT,
-            null, null, null, null, null,
-            TLSSecurityParameters.PROTOCOL_VERSION);
-        tlsConfig.trustAllCertificates = true;
-        tlsConfig.ignoreCommonNameMismatch = true;
-        tlsSocket = new TLSSocket();
-        tlsSocket.addEventListener(ProgressEvent.SOCKET_DATA, onSocketData);
-        socket = tlsSocket;
-      } else {
-        rawSocket.addEventListener(ProgressEvent.SOCKET_DATA, onSocketData);
-        socket = rawSocket;
-      }
-    }
-    rawSocket.addEventListener(Event.CLOSE, onSocketClose);
-    rawSocket.addEventListener(Event.CONNECT, onSocketConnect);
-    rawSocket.addEventListener(IOErrorEvent.IO_ERROR, onSocketIoError);
-    rawSocket.addEventListener(SecurityErrorEvent.SECURITY_ERROR, onSocketSecurityError);
-    rawSocket.connect(host, port);
-  }
-  
-  public function send(encData:String):int {
-    var data:String = decodeURIComponent(encData);
-    if (readyState == OPEN) {
-      socket.writeByte(0x00);
-      socket.writeUTFBytes(data);
-      socket.writeByte(0xff);
-      socket.flush();
-      main.log("sent: " + data);
-      return -1;
-    } else if (readyState == CLOSED) {
-      var bytes:ByteArray = new ByteArray();
-      bytes.writeUTFBytes(data);
-      bufferedAmount += bytes.length; // not sure whether it should include \x00 and \xff
-      // We use return value to let caller know bufferedAmount because we cannot fire
-      // stateChange event here which causes weird error:
-      // > You are trying to call recursively into the Flash Player which is not allowed.
-      return bufferedAmount;
-    } else {
-      main.fatal("INVALID_STATE_ERR: invalid state");
-      return 0;
-    }
-  }
-  
-  public function close():void {
-    main.log("close");
-    dataQueue = [];
-    try {
-      if (readyState == OPEN) {
-        socket.writeByte(0xff);
-        socket.writeByte(0x00);
-        socket.flush();
-      }
-      socket.close();
-    } catch (ex:Error) { }
-    readyState = CLOSED;
-    // We don't fire any events here because it causes weird error:
-    // > You are trying to call recursively into the Flash Player which is not allowed.
-    // We do something equivalent in JavaScript WebSocket#close instead.
-  }
-  
-  public function getReadyState():int {
-    return readyState;
-  }
-  
-  public function getBufferedAmount():int {
-    return bufferedAmount;
-  }
-  
-  private function onSocketConnect(event:Event):void {
-    main.log("connected");
-
-    if (scheme == "wss") {
-      main.log("starting SSL/TLS");
-      tlsSocket.startTLS(rawSocket, host, tlsConfig);
-    }
-    
-    dataQueue = [];
-    var hostValue:String = host + (port == 80 ? "" : ":" + port);
-    var cookie:String = "";
-    if (main.getCallerHost() == host) {
-      cookie = ExternalInterface.call("function(){return document.cookie}");
-    }
-    var key1:String = generateKey();
-    var key2:String = generateKey();
-    var key3:String = generateKey3();
-    expectedDigest = getSecurityDigest(key1, key2, key3);
-    var opt:String = "";
-    if (protocol) opt += "WebSocket-Protocol: " + protocol + "\r\n";
-    // if caller passes additional headers they must end with "\r\n"
-    if (headers) opt += headers;
-    
-    var req:String = StringUtil.substitute(
-      "GET {0} HTTP/1.1\r\n" +
-      "Upgrade: WebSocket\r\n" +
-      "Connection: Upgrade\r\n" +
-      "Host: {1}\r\n" +
-      "Origin: {2}\r\n" +
-      "Cookie: {3}\r\n" +
-      "Sec-WebSocket-Key1: {4}\r\n" +
-      "Sec-WebSocket-Key2: {5}\r\n" +
-      "{6}" +
-      "\r\n",
-      path, hostValue, origin, cookie, key1, key2, opt);
-    main.log("request header:\n" + req);
-    socket.writeUTFBytes(req);
-    main.log("sent key3: " + key3);
-    writeBytes(key3);
-    socket.flush();
-  }
-
-  private function onSocketClose(event:Event):void {
-    main.log("closed");
-    readyState = CLOSED;
-    notifyStateChange();
-    dispatchEvent(new Event("close"));
-  }
-
-  private function onSocketIoError(event:IOErrorEvent):void {
-    var message:String;
-    if (readyState == CONNECTING) {
-      message = "cannot connect to Web Socket server at " + url + " (IoError)";
-    } else {
-      message = "error communicating with Web Socket server at " + url + " (IoError)";
-    }
-    onError(message);
-  }
-
-  private function onSocketSecurityError(event:SecurityErrorEvent):void {
-    var message:String;
-    if (readyState == CONNECTING) {
-      message =
-          "cannot connect to Web Socket server at " + url + " (SecurityError)\n" +
-          "make sure the server is running and Flash socket policy file is correctly placed";
-    } else {
-      message = "error communicating with Web Socket server at " + url + " (SecurityError)";
-    }
-    onError(message);
-  }
-  
-  private function onError(message:String):void {
-    var state:int = readyState;
-    if (state == CLOSED) return;
-    main.error(message);
-    close();
-    notifyStateChange();
-    dispatchEvent(new Event(state == CONNECTING ? "close" : "error"));
-  }
-
-  private function onSocketData(event:ProgressEvent):void {
-    var pos:int = buffer.length;
-    socket.readBytes(buffer, pos);
-    for (; pos < buffer.length; ++pos) {
-      if (headerState < 4) {
-        // try to find "\r\n\r\n"
-        if ((headerState == 0 || headerState == 2) && buffer[pos] == 0x0d) {
-          ++headerState;
-        } else if ((headerState == 1 || headerState == 3) && buffer[pos] == 0x0a) {
-          ++headerState;
-        } else {
-          headerState = 0;
-        }
-        if (headerState == 4) {
-          var headerStr:String = readUTFBytes(buffer, 0, pos + 1);
-          main.log("response header:\n" + headerStr);
-          if (!validateHeader(headerStr)) return;
-          removeBufferBefore(pos + 1);
-          pos = -1;
-        }
-      } else if (headerState == 4) {
-        if (pos == 15) {
-          var replyDigest:String = readBytes(buffer, 0, 16);
-          main.log("reply digest: " + replyDigest);
-          if (replyDigest != expectedDigest) {
-            onError("digest doesn't match: " + replyDigest + " != " + expectedDigest);
-            return;
-          }
-          headerState = 5;
-          removeBufferBefore(pos + 1);
-          pos = -1;
-          readyState = OPEN;
-          notifyStateChange();
-          dispatchEvent(new Event("open"));
-        }
-      } else {
-        if (buffer[pos] == 0xff && pos > 0) {
-          if (buffer[0] != 0x00) {
-            onError("data must start with \\x00");
-            return;
-          }
-          var data:String = readUTFBytes(buffer, 1, pos - 1);
-          main.log("received: " + data);
-          dataQueue.push(encodeURIComponent(data));
-          dispatchEvent(new Event("message"));
-          removeBufferBefore(pos + 1);
-          pos = -1;
-        } else if (pos == 1 && buffer[0] == 0xff && buffer[1] == 0x00) { // closing
-          main.log("received closing packet");
-          removeBufferBefore(pos + 1);
-          pos = -1;
-          close();
-          notifyStateChange();
-          dispatchEvent(new Event("close"));
-        }
-      }
-    }
-  }
-
-  public function readSocketData():Array {
-    var q:Array = dataQueue;
-    if (dataQueue.length > 0) {
-      dataQueue = [];
-    }
-    return q;
-  }
-  
-  private function validateHeader(headerStr:String):Boolean {
-    var lines:Array = headerStr.split(/\r\n/);
-    if (!lines[0].match(/^HTTP\/1.1 101 /)) {
-      onError("bad response: " + lines[0]);
-      return false;
-    }
-    var header:Object = {};
-    var lowerHeader:Object = {};
-    for (var i:int = 1; i < lines.length; ++i) {
-      if (lines[i].length == 0) continue;
-      var m:Array = lines[i].match(/^(\S+): (.*)$/);
-      if (!m) {
-        onError("failed to parse response header line: " + lines[i]);
-        return false;
-      }
-      header[m[1].toLowerCase()] = m[2];
-      lowerHeader[m[1].toLowerCase()] = m[2].toLowerCase();
-    }
-    if (lowerHeader["upgrade"] != "websocket") {
-      onError("invalid Upgrade: " + header["Upgrade"]);
-      return false;
-    }
-    if (lowerHeader["connection"] != "upgrade") {
-      onError("invalid Connection: " + header["Connection"]);
-      return false;
-    }
-    if (!lowerHeader["sec-websocket-origin"]) {
-      if (lowerHeader["websocket-origin"]) {
-        onError(
-          "The WebSocket server speaks old WebSocket protocol, " +
-          "which is not supported by web-socket-js. " +
-          "It requires WebSocket protocol 76 or later. " +
-          "Try newer version of the server if available.");
-      } else {
-        onError("header Sec-WebSocket-Origin is missing");
-      }
-      return false;
-    }
-    var resOrigin:String = lowerHeader["sec-websocket-origin"];
-    if (resOrigin != origin) {
-      onError("origin doesn't match: '" + resOrigin + "' != '" + origin + "'");
-      return false;
-    }
-    if (protocol && header["sec-websocket-protocol"] != protocol) {
-      onError("protocol doesn't match: '" +
-        header["websocket-protocol"] + "' != '" + protocol + "'");
-      return false;
-    }
-    return true;
-  }
-
-  private function removeBufferBefore(pos:int):void {
-    if (pos == 0) return;
-    var nextBuffer:ByteArray = new ByteArray();
-    buffer.position = pos;
-    buffer.readBytes(nextBuffer);
-    buffer = nextBuffer;
-  }
-  
-  private function notifyStateChange():void {
-    dispatchEvent(new WebSocketStateEvent("stateChange", readyState, bufferedAmount));
-  }
-  
-  private function initNoiseChars():void {
-    noiseChars = new Array();
-    for (var i:int = 0x21; i <= 0x2f; ++i) {
-      noiseChars.push(String.fromCharCode(i));
-    }
-    for (var j:int = 0x3a; j <= 0x7a; ++j) {
-      noiseChars.push(String.fromCharCode(j));
-    }
-  }
-  
-  private function generateKey():String {
-    var spaces:uint = randomInt(1, 12);
-    var max:uint = uint.MAX_VALUE / spaces;
-    var number:uint = randomInt(0, max);
-    var key:String = (number * spaces).toString();
-    var noises:int = randomInt(1, 12);
-    var pos:int;
-    for (var i:int = 0; i < noises; ++i) {
-      var char:String = noiseChars[randomInt(0, noiseChars.length - 1)];
-      pos = randomInt(0, key.length);
-      key = key.substr(0, pos) + char + key.substr(pos);
-    }
-    for (var j:int = 0; j < spaces; ++j) {
-      pos = randomInt(1, key.length - 1);
-      key = key.substr(0, pos) + " " + key.substr(pos);
-    }
-    return key;
-  }
-  
-  private function generateKey3():String {
-    var key3:String = "";
-    for (var i:int = 0; i < 8; ++i) {
-      key3 += String.fromCharCode(randomInt(0, 255));
-    }
-    return key3;
-  }
-  
-  private function getSecurityDigest(key1:String, key2:String, key3:String):String {
-    var bytes1:String = keyToBytes(key1);
-    var bytes2:String = keyToBytes(key2);
-    return MD5.rstr_md5(bytes1 + bytes2 + key3);
-  }
-  
-  private function keyToBytes(key:String):String {
-    var keyNum:uint = parseInt(key.replace(/[^\d]/g, ""));
-    var spaces:uint = 0;
-    for (var i:int = 0; i < key.length; ++i) {
-      if (key.charAt(i) == " ") ++spaces;
-    }
-    var resultNum:uint = keyNum / spaces;
-    var bytes:String = "";
-    for (var j:int = 3; j >= 0; --j) {
-      bytes += String.fromCharCode((resultNum >> (j * 8)) & 0xff);
-    }
-    return bytes;
-  }
-  
-  // Writes byte sequence to socket.
-  // bytes is String in special format where bytes[i] is i-th byte, not i-th character.
-  private function writeBytes(bytes:String):void {
-    for (var i:int = 0; i < bytes.length; ++i) {
-      socket.writeByte(bytes.charCodeAt(i));
-    }
-  }
-  
-  // Reads specified number of bytes from buffer, and returns it as special format String
-  // where bytes[i] is i-th byte (not i-th character).
-  private function readBytes(buffer:ByteArray, start:int, numBytes:int):String {
-    buffer.position = start;
-    var bytes:String = "";
-    for (var i:int = 0; i < numBytes; ++i) {
-      // & 0xff is to make \x80-\xff positive number.
-      bytes += String.fromCharCode(buffer.readByte() & 0xff);
-    }
-    return bytes;
-  }
-  
-  private function readUTFBytes(buffer:ByteArray, start:int, numBytes:int):String {
-    buffer.position = start;
-    var data:String = "";
-    for(var i:int = start; i < start + numBytes; ++i) {
-      // Workaround of a bug of ByteArray#readUTFBytes() that bytes after "\x00" is discarded.
-      if (buffer[i] == 0x00) {
-        data += buffer.readUTFBytes(i - buffer.position) + "\x00";
-        buffer.position = i + 1;
-      }
-    }
-    data += buffer.readUTFBytes(start + numBytes - buffer.position);
-    return data;
-  }
-  
-  private function randomInt(min:uint, max:uint):uint {
-    return min + Math.floor(Math.random() * (Number(max) - min + 1));
-  }
-
-  // for debug
-  private function dumpBytes(bytes:String):void {
-    var output:String = "";
-    for (var i:int = 0; i < bytes.length; ++i) {
-      output += bytes.charCodeAt(i).toString() + ", ";
-    }
-    main.log(output);
-  }
-  
-}
-
-}