// Copyright: Hiroshi Ichikawa // License: New BSD License // Reference: http://dev.w3.org/html5/websockets/ // Reference: http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 package { import com.adobe.net.proxies.RFC2817Socket; import com.gsolo.encryption.MD5; import com.hurlant.crypto.tls.TLSConfig; import com.hurlant.crypto.tls.TLSEngine; import com.hurlant.crypto.tls.TLSSecurityParameters; import com.hurlant.crypto.tls.TLSSocket; import flash.display.*; import flash.events.*; import flash.external.*; import flash.net.*; import flash.system.*; import flash.utils.*; import mx.controls.*; import mx.core.*; import mx.events.*; import mx.utils.*; 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 id:int; private var rawSocket:Socket; private var tlsSocket:TLSSocket; private var tlsConfig:TLSConfig; private var socket:Socket; 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 requestedProtocols:Array; private var acceptedProtocol:String; private var buffer:ByteArray = new ByteArray(); private var headerState:int = 0; private var readyState:int = CONNECTING; private var cookie:String; private var headers:String; private var noiseChars:Array; private var expectedDigest:String; private var logger:IWebSocketLogger; public function WebSocket( id:int, url:String, protocols:Array, origin:String, proxyHost:String, proxyPort:int, cookie:String, headers:String, logger:IWebSocketLogger) { this.logger = logger; this.id = id; initNoiseChars(); this.url = url; var m:Array = url.match(/^(\w+):\/\/([^\/:]+)(:(\d+))?(\/.*)?(\?.*)?$/); if (!m) fatal("SYNTAX_ERR: invalid url: " + url); this.scheme = m[1]; this.host = m[2]; var defaultPort:int = scheme == "wss" ? 443 : 80; this.port = parseInt(m[4]) || defaultPort; this.path = (m[5] || "/") + (m[6] || ""); this.origin = origin; this.requestedProtocols = protocols; this.cookie = cookie; // 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") { 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); } /** * @return This WebSocket's ID. */ public function getId():int { return this.id; } /** * @return this WebSocket's readyState. */ public function getReadyState():int { return this.readyState; } public function getAcceptedProtocol():String { return this.acceptedProtocol; } 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(); logger.log("sent: " + data); return -1; } else if (readyState == CLOSING || readyState == CLOSED) { var bytes:ByteArray = new ByteArray(); bytes.writeUTFBytes(data); return bytes.length; // not sure whether it should include \x00 and \xff } else { fatal("invalid state"); return 0; } } public function close(isError:Boolean = false):void { logger.log("close"); try { if (readyState == OPEN && !isError) { socket.writeByte(0xff); socket.writeByte(0x00); socket.flush(); } socket.close(); } catch (ex:Error) { } readyState = CLOSED; this.dispatchEvent(new WebSocketEvent(isError ? "error" : "close")); } private function onSocketConnect(event:Event):void { logger.log("connected"); if (scheme == "wss") { logger.log("starting SSL/TLS"); tlsSocket.startTLS(rawSocket, host, tlsConfig); } var defaultPort:int = scheme == "wss" ? 443 : 80; var hostValue:String = host + (port == defaultPort ? "" : ":" + port); var key1:String = generateKey(); var key2:String = generateKey(); var key3:String = generateKey3(); expectedDigest = getSecurityDigest(key1, key2, key3); var opt:String = ""; if (requestedProtocols.length > 0) { opt += "Sec-WebSocket-Protocol: " + requestedProtocols.join(",") + "\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); logger.log("request header:\n" + req); socket.writeUTFBytes(req); logger.log("sent key3: " + key3); writeBytes(key3); socket.flush(); } private function onSocketClose(event:Event):void { logger.log("closed"); readyState = CLOSED; this.dispatchEvent(new WebSocketEvent("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 { if (readyState == CLOSED) return; logger.error(message); close(readyState != CONNECTING); } 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); logger.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); logger.log("reply digest: " + replyDigest); if (replyDigest != expectedDigest) { onError("digest doesn't match: " + replyDigest + " != " + expectedDigest); return; } headerState = 5; removeBufferBefore(pos + 1); pos = -1; readyState = OPEN; this.dispatchEvent(new WebSocketEvent("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); logger.log("received: " + data); this.dispatchEvent(new WebSocketEvent("message", encodeURIComponent(data))); removeBufferBefore(pos + 1); pos = -1; } else if (pos == 1 && buffer[0] == 0xff && buffer[1] == 0x00) { // closing logger.log("received closing packet"); removeBufferBefore(pos + 1); pos = -1; close(); } } } } 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 (requestedProtocols.length > 0) { acceptedProtocol = header["sec-websocket-protocol"]; if (requestedProtocols.indexOf(acceptedProtocol) < 0) { onError("protocol doesn't match: '" + acceptedProtocol + "' not in '" + requestedProtocols.join(",") + "'"); 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 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)); } private function fatal(message:String):void { logger.error(message); throw message; } // 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() + ", "; } logger.log(output); } } }