July 2019 - tor-commits - lists.torproject.org

[snowflake/master] Rename Cakefile and make it work
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit f97c37fe5d98ad2df5f2e8cd6aac5a79882def65 Author: Arlo Breault <arlolra(a)gmail.com> Date: Sat Jul 6 15:48:33 2019 +0200 Rename Cakefile and make it work --- .travis.yml | 1 - proxy/Cakefile.js | 102 -------------------------------------- proxy/coffeelint.json | 135 -------------------------------------------------- proxy/make.js | 108 ++++++++++++++++++++++++++++++++++++++++ proxy/package.json | 15 +++--- 5 files changed, 114 insertions(+), 247 deletions(-) diff --git a/.travis.yml b/.travis.yml index 3037f5a..29d6525 100644 --- a/.travis.yml +++ b/.travis.yml @@ -39,5 +39,4 @@ script: - go vet ./... - go test -v -race ./... - cd proxy - - npm run-script lint - npm test diff --git a/proxy/Cakefile.js b/proxy/Cakefile.js deleted file mode 100644 index 91ceea4..0000000 --- a/proxy/Cakefile.js +++ /dev/null @@ -1,102 +0,0 @@ - -var fs = require('fs'); -var { exec, spawn, execSync } = require('child_process'); - -// All coffeescript files required. -var FILES = [ - 'broker.coffee', - 'config.coffee', - 'proxypair.coffee', - 'snowflake.coffee', - 'ui.coffee', - 'util.coffee', - 'websocket.coffee', - 'shims.coffee' -]; - -var INITS = [ - 'init-badge.coffee', - 'init-node.coffee', - 'init-webext.coffee' -]; - -var FILES_SPEC = [ - 'spec/broker.spec.coffee', - 'spec/init.spec.coffee', - 'spec/proxypair.spec.coffee', - 'spec/snowflake.spec.coffee', - 'spec/ui.spec.coffee', - 'spec/util.spec.coffee', - 'spec/websocket.spec.coffee' -]; - -var OUTFILE = 'snowflake.js'; - -var STATIC = 'static'; - -var copyStaticFiles = function() { - return exec('cp ' + STATIC + '/* build/'); -}; - -var compileCoffee = function(outDir, init) { - var files; - files = FILES.concat('init-' + init + '.coffee'); - return exec('cat ' + files.join(' ') + ' | coffee -cs > ' + outDir + '/' + OUTFILE, function(err, stdout, stderr) { - if (err) { - throw err; - } - }); -}; - -task('test', 'snowflake unit tests', function() { - var jasmineFiles, outFile, proc; - exec('mkdir -p test'); - exec('jasmine init >&-'); - // Simply concat all the files because we're not using node exports. - jasmineFiles = FILES.concat('init-badge.coffee', FILES_SPEC); - outFile = 'test/bundle.spec.coffee'; - exec('echo "TESTING = true" > ' + outFile); - exec('cat ' + jasmineFiles.join(' ') + ' | cat >> ' + outFile); - execSync('coffee -cb ' + outFile); - proc = spawn('jasmine', ['test/bundle.spec.js'], { - stdio: 'inherit' - }); - return proc.on("exit", function(code) { - return process.exit(code); - }); -}); - -task('build', 'build the snowflake proxy', function() { - exec('mkdir -p build'); - copyStaticFiles(); - compileCoffee('build', 'badge'); - return console.log('Snowflake prepared.'); -}); - -task('webext', 'build the webextension', function() { - exec('mkdir -p webext'); - compileCoffee('webext', 'webext'); - return console.log('Webextension prepared.'); -}); - -task('node', 'build the node binary', function() { - exec('mkdir -p build'); - compileCoffee('build', 'node'); - return console.log('Node prepared.'); -}); - -task('lint', 'ensure idiomatic coffeescript', function() { - var filesAll, proc; - filesAll = FILES.concat(INITS, FILES_SPEC); - proc = spawn('coffeelint', filesAll, { - file: 'coffeelint.json', - stdio: 'inherit' - }); - return proc.on("exit", function(code) { - return process.exit(code); - }); -}); - -task('clean', 'remove all built files', function() { - return exec('rm -r build'); -}); diff --git a/proxy/coffeelint.json b/proxy/coffeelint.json deleted file mode 100644 index 239092c..0000000 --- a/proxy/coffeelint.json +++ /dev/null @@ -1,135 +0,0 @@ -{ - "arrow_spacing": { - "level": "error" - }, - "braces_spacing": { - "level": "error", - "spaces": 1, - "empty_object_spaces": 0 - }, - "camel_case_classes": { - "level": "error" - }, - "coffeescript_error": { - "level": "error" - }, - "colon_assignment_spacing": { - "level": "ignore", - "spacing": { - "left": 0, - "right": 0 - } - }, - "cyclomatic_complexity": { - "level": "ignore", - "value": 10 - }, - "duplicate_key": { - "level": "error" - }, - "empty_constructor_needs_parens": { - "level": "ignore" - }, - "ensure_comprehensions": { - "level": "warn" - }, - "eol_last": { - "level": "ignore" - }, - "indentation": { - "value": 2, - "level": "error" - }, - "line_endings": { - "level": "ignore", - "value": "unix" - }, - "max_line_length": { - "value": 80, - "level": "warn", - "limitComments": true - }, - "missing_fat_arrows": { - "level": "ignore", - "is_strict": false - }, - "newlines_after_classes": { - "value": 3, - "level": "ignore" - }, - "no_backticks": { - "level": "error" - }, - "no_debugger": { - "level": "warn", - "console": false - }, - "no_empty_functions": { - "level": "ignore" - }, - "no_empty_param_list": { - "level": "ignore" - }, - "no_implicit_braces": { - "level": "ignore", - "strict": true - }, - "no_implicit_parens": { - "level": "ignore", - "strict": true - }, - "no_interpolation_in_single_quotes": { - "level": "ignore" - }, - "no_nested_string_interpolation": { - "level": "warn" - }, - "no_plusplus": { - "level": "ignore" - }, - "no_private_function_fat_arrows": { - "level": "warn" - }, - "no_stand_alone_at": { - "level": "error" - }, - "no_tabs": { - "level": "error" - }, - "no_this": { - "level": "error" - }, - "no_throwing_strings": { - "level": "error" - }, - "no_trailing_semicolons": { - "level": "error" - }, - "no_trailing_whitespace": { - "level": "error", - "allowed_in_comments": false, - "allowed_in_empty_lines": false - }, - "no_unnecessary_double_quotes": { - "level": "ignore" - }, - "no_unnecessary_fat_arrows": { - "level": "warn" - }, - "non_empty_constructor_needs_parens": { - "level": "ignore" - }, - "prefer_english_operator": { - "level": "ignore", - "doubleNotLevel": "ignore" - }, - "space_operators": { - "level": "ignore" - }, - "spacing_after_comma": { - "level": "ignore" - }, - "transform_messes_up_line_numbers": { - "level": "warn" - } -} diff --git a/proxy/make.js b/proxy/make.js new file mode 100755 index 0000000..f5f1c0a --- /dev/null +++ b/proxy/make.js @@ -0,0 +1,108 @@ +#!/usr/bin/env node + +var fs = require('fs'); +var { exec, spawn, execSync } = require('child_process'); + +// All files required. +var FILES = [ + 'broker.js', + 'config.js', + 'proxypair.js', + 'snowflake.js', + 'ui.js', + 'util.js', + 'websocket.js', + 'shims.js' +]; + +var INITS = [ + 'init-badge.js', + 'init-node.js', + 'init-webext.js' +]; + +var FILES_SPEC = [ + 'spec/broker.spec.js', + 'spec/init.spec.js', + 'spec/proxypair.spec.js', + 'spec/snowflake.spec.js', + 'spec/ui.spec.js', + 'spec/util.spec.js', + 'spec/websocket.spec.js' +]; + +var OUTFILE = 'snowflake.js'; + +var STATIC = 'static'; + +var copyStaticFiles = function() { + exec('cp ' + STATIC + '/* build/'); +}; + +var concatJS = function(outDir, init) { + var files; + files = FILES.concat(`init-${init}.js`); + return exec(`cat ${files.join(' ')} > ${outDir}/${OUTFILE}`, function(err, stdout, stderr) { + if (err) { + throw err; + } + }); +}; + +var tasks = new Map(); + +var task = function(key, msg, func) { + tasks.set(key, { + msg, func + }); +}; + +task('test', 'snowflake unit tests', function() { + var jasmineFiles, outFile, proc; + exec('mkdir -p test'); + exec('jasmine init >&-'); + // Simply concat all the files because we're not using node exports. + jasmineFiles = FILES.concat('init-badge.js', FILES_SPEC); + outFile = 'test/bundle.spec.js'; + exec('echo "TESTING = true" > ' + outFile); + exec('cat ' + jasmineFiles.join(' ') + ' | cat >> ' + outFile); + proc = spawn('jasmine', ['test/bundle.spec.js'], { + stdio: 'inherit' + }); + proc.on("exit", function(code) { + process.exit(code); + }); +}); + +task('build', 'build the snowflake proxy', function() { + exec('mkdir -p build'); + copyStaticFiles(); + concatJS('build', 'badge'); + console.log('Snowflake prepared.'); +}); + +task('webext', 'build the webextension', function() { + exec('mkdir -p webext'); + concatJS('webext', 'webext'); + console.log('Webextension prepared.'); +}); + +task('node', 'build the node binary', function() { + exec('mkdir -p build'); + concatJS('build', 'node'); + console.log('Node prepared.'); +}); + +task('clean', 'remove all built files', function() { + exec('rm -r build test spec/support'); +}); + +var cmd = process.argv[2]; + +if (tasks.has(cmd)) { + var t = tasks.get(cmd); + console.log(t.msg); + t.func(); +} else { + console.error('Command not supported.'); +} diff --git a/proxy/package.json b/proxy/package.json index c907fed..ca13a52 100644 --- a/proxy/package.json +++ b/proxy/package.json @@ -2,17 +2,16 @@ "name": "snowflake-pt", "version": "0.0.0-git", "description": "Snowflake is a WebRTC pluggable transport for Tor.", - "main": "snowflake.coffee", + "main": "build/snowflake.js", "directories": { "test": "test" }, "scripts": { - "test": "cake test", - "lint": "cake lint", - "build": "cake build", - "webext": "cake webext", - "clean": "cake clean", - "prepublish": "cake node", + "test": "node make.js test", + "build": "node make.js build", + "webext": "node make.js webext", + "clean": "node make.js clean", + "prepublish": "node make.js node", "start": "node build/snowflake.js" }, "bin": { @@ -21,11 +20,9 @@ "author": "Serene Han", "license": "BSD-3-Clause", "devDependencies": { - "coffeelint": "^1.16.0", "jasmine": "2.5.2" }, "dependencies": { - "coffeescript": "^2.4.1", "wrtc": "^0.0.61", "ws": "^3.3.1", "xmlhttprequest": "^1.8.0"

1 0

[snowflake/master] Close over init so that we can return if a feature isn't detected
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit 27a92ab03a1e296a4e73f6861b31931e4aeba221 Author: Arlo Breault <arlolra(a)gmail.com> Date: Sat Jul 6 16:40:03 2019 +0200 Close over init so that we can return if a feature isn't detected I guess alternatively, just use an if/else block. --- proxy/init-badge.js | 124 +++++++++++++++++++++++++++------------------------ proxy/init-webext.js | 119 ++++++++++++++++++++++++------------------------ 2 files changed, 126 insertions(+), 117 deletions(-) diff --git a/proxy/init-badge.js b/proxy/init-badge.js index 7e5277f..30c0218 100644 --- a/proxy/init-badge.js +++ b/proxy/init-badge.js @@ -2,72 +2,78 @@ Entry point. */ -if (((typeof TESTING === "undefined" || TESTING === null) || !TESTING) && !Util.featureDetect()) { - console.log('webrtc feature not detected. shutting down'); - return; -} +var snowflake, query, debug, silenceNotifications, log, dbg, init; -var snowflake = null; +;(function() { -var query = Query.parse(location); + if (((typeof TESTING === "undefined" || TESTING === null) || !TESTING) && !Util.featureDetect()) { + console.log('webrtc feature not detected. shutting down'); + return; + } -var debug = Params.getBool(query, 'debug', false); + snowflake = null; -var silenceNotifications = Params.getBool(query, 'silent', false); + query = Query.parse(location); -// Log to both console and UI if applicable. -// Requires that the snowflake and UI objects are hooked up in order to -// log to console. -var log = function(msg) { - console.log('Snowflake: ' + msg); - return snowflake != null ? snowflake.ui.log(msg) : void 0; -}; + debug = Params.getBool(query, 'debug', false); -var dbg = function(msg) { - if (debug || ((snowflake != null ? snowflake.ui : void 0) instanceof DebugUI)) { - return log(msg); - } -}; + silenceNotifications = Params.getBool(query, 'silent', false); -var init = function() { - var broker, config, ui; - config = new Config; - if ('off' !== query['ratelimit']) { - config.rateLimitBytes = Params.getByteCount(query, 'ratelimit', config.rateLimitBytes); - } - ui = null; - if (document.getElementById('badge') !== null) { - ui = new BadgeUI(); - } else if (document.getElementById('status') !== null) { - ui = new DebugUI(); - } else { - ui = new UI(); - } - broker = new Broker(config.brokerUrl); - snowflake = new Snowflake(config, ui, broker); - log('== snowflake proxy =='); - if (Util.snowflakeIsDisabled(config.cookieName)) { - // Do not activate the proxy if any number of conditions are true. - log('Currently not active.'); - return; - } - // Otherwise, begin setting up WebRTC and acting as a proxy. - dbg('Contacting Broker at ' + broker.url); - snowflake.setRelayAddr(config.relayAddr); - return snowflake.beginWebRTC(); -}; + // Log to both console and UI if applicable. + // Requires that the snowflake and UI objects are hooked up in order to + // log to console. + log = function(msg) { + console.log('Snowflake: ' + msg); + return snowflake != null ? snowflake.ui.log(msg) : void 0; + }; -// Notification of closing tab with active proxy. -window.onbeforeunload = function() { - if (!silenceNotifications && Snowflake.MODE.WEBRTC_READY === snowflake.state) { - return Snowflake.MESSAGE.CONFIRMATION; - } - return null; -}; + dbg = function(msg) { + if (debug || ((snowflake != null ? snowflake.ui : void 0) instanceof DebugUI)) { + return log(msg); + } + }; + + init = function() { + var broker, config, ui; + config = new Config; + if ('off' !== query['ratelimit']) { + config.rateLimitBytes = Params.getByteCount(query, 'ratelimit', config.rateLimitBytes); + } + ui = null; + if (document.getElementById('badge') !== null) { + ui = new BadgeUI(); + } else if (document.getElementById('status') !== null) { + ui = new DebugUI(); + } else { + ui = new UI(); + } + broker = new Broker(config.brokerUrl); + snowflake = new Snowflake(config, ui, broker); + log('== snowflake proxy =='); + if (Util.snowflakeIsDisabled(config.cookieName)) { + // Do not activate the proxy if any number of conditions are true. + log('Currently not active.'); + return; + } + // Otherwise, begin setting up WebRTC and acting as a proxy. + dbg('Contacting Broker at ' + broker.url); + snowflake.setRelayAddr(config.relayAddr); + return snowflake.beginWebRTC(); + }; + + // Notification of closing tab with active proxy. + window.onbeforeunload = function() { + if (!silenceNotifications && Snowflake.MODE.WEBRTC_READY === snowflake.state) { + return Snowflake.MESSAGE.CONFIRMATION; + } + return null; + }; + + window.onunload = function() { + snowflake.disable(); + return null; + }; -window.onunload = function() { - snowflake.disable(); - return null; -}; + window.onload = init; -window.onload = init; +}()); diff --git a/proxy/init-webext.js b/proxy/init-webext.js index 89072b8..3a2b120 100644 --- a/proxy/init-webext.js +++ b/proxy/init-webext.js @@ -2,73 +2,76 @@ Entry point. */ -var debug = false; +var debug, snowflake, config, broker, ui, log, dbg, init, update, silenceNotifications; -var snowflake = null; +;(function () { -var config = null; + silenceNotifications = false; + debug = false; + snowflake = null; + config = null; + broker = null; + ui = null; -var broker = null; + // Log to both console and UI if applicable. + // Requires that the snowflake and UI objects are hooked up in order to + // log to console. + log = function(msg) { + console.log('Snowflake: ' + msg); + return snowflake != null ? snowflake.ui.log(msg) : void 0; + }; -var ui = null; + dbg = function(msg) { + if (debug) { + return log(msg); + } + }; -// Log to both console and UI if applicable. -// Requires that the snowflake and UI objects are hooked up in order to -// log to console. -var log = function(msg) { - console.log('Snowflake: ' + msg); - return snowflake != null ? snowflake.ui.log(msg) : void 0; -}; - -var dbg = function(msg) { - if (debug) { - return log(msg); + if (!Util.featureDetect()) { + chrome.runtime.onConnect.addListener(function(port) { + return port.postMessage({ + missingFeature: true + }); + }); + return; } -}; -if (!Util.featureDetect()) { - chrome.runtime.onConnect.addListener(function(port) { - return port.postMessage({ - missingFeature: true - }); - }); - return; -} + init = function() { + config = new Config; + ui = new WebExtUI(); + broker = new Broker(config.brokerUrl); + snowflake = new Snowflake(config, ui, broker); + log('== snowflake proxy =='); + return ui.initToggle(); + }; -var init = function() { - config = new Config; - ui = new WebExtUI(); - broker = new Broker(config.brokerUrl); - snowflake = new Snowflake(config, ui, broker); - log('== snowflake proxy =='); - return ui.initToggle(); -}; + update = function() { + if (!ui.enabled) { + // Do not activate the proxy if any number of conditions are true. + snowflake.disable(); + log('Currently not active.'); + return; + } + // Otherwise, begin setting up WebRTC and acting as a proxy. + dbg('Contacting Broker at ' + broker.url); + log('Starting snowflake'); + snowflake.setRelayAddr(config.relayAddr); + return snowflake.beginWebRTC(); + }; -var update = function() { - if (!ui.enabled) { - // Do not activate the proxy if any number of conditions are true. - snowflake.disable(); - log('Currently not active.'); - return; - } - // Otherwise, begin setting up WebRTC and acting as a proxy. - dbg('Contacting Broker at ' + broker.url); - log('Starting snowflake'); - snowflake.setRelayAddr(config.relayAddr); - return snowflake.beginWebRTC(); -}; + // Notification of closing tab with active proxy. + window.onbeforeunload = function() { + if (!silenceNotifications && Snowflake.MODE.WEBRTC_READY === snowflake.state) { + return Snowflake.MESSAGE.CONFIRMATION; + } + return null; + }; -// Notification of closing tab with active proxy. -window.onbeforeunload = function() { - if (!silenceNotifications && Snowflake.MODE.WEBRTC_READY === snowflake.state) { - return Snowflake.MESSAGE.CONFIRMATION; - } - return null; -}; + window.onunload = function() { + snowflake.disable(); + return null; + }; -window.onunload = function() { - snowflake.disable(); - return null; -}; + window.onload = init; -window.onload = init; +}());

1 0

[snowflake/master] Remove mentions of coffeescript from docs
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit d3080e25669fa8408e32d3a36c372d6a5ca59029 Author: Arlo Breault <arlolra(a)gmail.com> Date: Sat Jul 6 16:41:56 2019 +0200 Remove mentions of coffeescript from docs --- CONTRIBUTING.md | 8 ++------ README.md | 5 ++--- proxy/README.md | 3 +-- proxy/snowflake.js | 2 +- proxy/spec/proxypair.spec.js | 2 +- proxy/spec/util.spec.js | 2 -- proxy/util.js | 2 +- 7 files changed, 8 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1bb064f..9f8bae0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,5 @@ - When editing Go, please run `go fmt` before every commit. -- When editing coffeescript (in the `proxy/` directory), please run - `cake lint` and resolve any lint issues before every commit. - -- You may run tests locally with either `go test` or `cake test` for Go and - coffeescript, respectively. - +- You may run tests locally with either `go test` or `npm test` for Go and + JavaScript, respectively. diff --git a/README.md b/README.md index c031213..cd2641b 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Client: - Go 1.5+ Proxy: -- [CoffeeScript](coffeescript.org) +- JavaScript --- @@ -85,9 +85,8 @@ To run your own: ``` cd proxy/ -cake build +npm run build ``` -(Type `cake` by itself to see possible commands) Then, start a local http server in the `proxy/build/` in any way you like. For instance: diff --git a/proxy/README.md b/proxy/README.md index 634e13c..bd1f819 100644 --- a/proxy/README.md +++ b/proxy/README.md @@ -10,9 +10,8 @@ See https://snowflake.torproject.org/ for more info: ### Building ``` -cake build +npm run build ``` -(Type `cake` by itself to see possible commands) ### Testing diff --git a/proxy/snowflake.js b/proxy/snowflake.js index 7b584d1..2c08c4d 100644 --- a/proxy/snowflake.js +++ b/proxy/snowflake.js @@ -1,5 +1,5 @@ /* -A Coffeescript WebRTC snowflake proxy +A JavaScript WebRTC snowflake proxy Uses WebRTC from the client, and Websocket to the server. diff --git a/proxy/spec/proxypair.spec.js b/proxy/spec/proxypair.spec.js index 59ad85a..924aca0 100644 --- a/proxy/spec/proxypair.spec.js +++ b/proxy/spec/proxypair.spec.js @@ -40,7 +40,7 @@ describe('ProxyPair', function() { config = new Config; destination = []; - // Using the mock PeerConnection definition from spec/snowflake.spec.coffee. + // Using the mock PeerConnection definition from spec/snowflake.spec.js var pp = new ProxyPair(fakeRelay, rateLimit, config.pcConfig); beforeEach(function() { diff --git a/proxy/spec/util.spec.js b/proxy/spec/util.spec.js index c885b25..8f1ff7a 100644 --- a/proxy/spec/util.spec.js +++ b/proxy/spec/util.spec.js @@ -115,9 +115,7 @@ describe('Parse', function() { }, { // Modified from SDP sent by snowflake-client. - // coffeelint: disable sdp: "v=0\no=- 7860378660295630295 2 IN IP4 127.0.0.1\ns=-\nt=0 0\na=group:BUNDLE data\na=msid-semantic: WMS\nm=application 54653 DTLS/SCTP 5000\nc=IN IP4 1.2.3.4\na=candidate:3581707038 1 udp 2122260223 192.168.0.1 54653 typ host generation 0 network-id 1 network-cost 50\na=candidate:2617212910 1 tcp 1518280447 192.168.0.1 59673 typ host tcptype passive generation 0 network-id 1 network-cost 50\na=candidate:2082671819 1 udp 1686052607 1.2.3.4 54653 typ srflx raddr 192.168.0.1 rport 54653 generation 0 network-id 1 network-cost 50\na=ice-ufrag:IBdf\na=ice-pwd:G3lTrrC9gmhQx481AowtkhYz\na=fingerprint:sha-256 53:F8:84:D9:3C:1F:A0:44:AA:D6:3C:65:80:D3:CB:6F:23:90:17:41:06:F9:9C:10:D8:48:4A:A8:B6:FA:14:A1\na=setup:actpass\na=mid:data\na=sctpmap:5000 webrtc-datachannel 1024", - // coffeelint: enable expected: '1.2.3.4' }, { diff --git a/proxy/util.js b/proxy/util.js index 328fd9b..6d3651f 100644 --- a/proxy/util.js +++ b/proxy/util.js @@ -1,5 +1,5 @@ /* -A Coffeescript WebRTC snowflake proxy +A JavaScript WebRTC snowflake proxy Contains helpers for parsing query strings and other utilities. */

1 0

[snowflake/master] Use at least v6 of node on travis for destructuring assignment
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit 99952ca7de2e5d73dee5b3f17fe3da449cad6a4d Author: Arlo Breault <arlolra(a)gmail.com> Date: Sat Jul 6 16:59:37 2019 +0200 Use at least v6 of node on travis for destructuring assignment --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 29d6525..259d9eb 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,7 +16,7 @@ go: - 1.10.x env: - - TRAVIS_NODE_VERSION="4.2" CC="gcc-5" CXX="g++-5" + - TRAVIS_NODE_VERSION="6" CC="gcc-5" CXX="g++-5" before_install: - nvm install $TRAVIS_NODE_VERSION

1 0

[snowflake/master] Ensure `snnowflake` was initialized in unload handlers
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit 3455cd5da831ad77bd6e77544dba21134a294514 Author: Arlo Breault <arlolra(a)gmail.com> Date: Wed Jul 10 10:52:51 2019 +0200 Ensure `snnowflake` was initialized in unload handlers --- proxy/init-badge.js | 8 ++++++-- proxy/init-webext.js | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/proxy/init-badge.js b/proxy/init-badge.js index 30c0218..09579e6 100644 --- a/proxy/init-badge.js +++ b/proxy/init-badge.js @@ -63,14 +63,18 @@ var snowflake, query, debug, silenceNotifications, log, dbg, init; // Notification of closing tab with active proxy. window.onbeforeunload = function() { - if (!silenceNotifications && Snowflake.MODE.WEBRTC_READY === snowflake.state) { + if ( + !silenceNotifications && + snowflake !== null && + Snowflake.MODE.WEBRTC_READY === snowflake.state + ) { return Snowflake.MESSAGE.CONFIRMATION; } return null; }; window.onunload = function() { - snowflake.disable(); + if (snowflake !== null) { snowflake.disable(); } return null; }; diff --git a/proxy/init-webext.js b/proxy/init-webext.js index 3a2b120..ee755c6 100644 --- a/proxy/init-webext.js +++ b/proxy/init-webext.js @@ -61,14 +61,18 @@ var debug, snowflake, config, broker, ui, log, dbg, init, update, silenceNotific // Notification of closing tab with active proxy. window.onbeforeunload = function() { - if (!silenceNotifications && Snowflake.MODE.WEBRTC_READY === snowflake.state) { + if ( + !silenceNotifications && + snowflake !== null && + Snowflake.MODE.WEBRTC_READY === snowflake.state + ) { return Snowflake.MESSAGE.CONFIRMATION; } return null; }; window.onunload = function() { - snowflake.disable(); + if (snowflake !== null) { snowflake.disable(); } return null; };

1 0

[snowflake/master] Don't specify port for stun server
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit fb0578d84016439f387e1da37e23b4d5bc2f8a17 Author: Arlo Breault <arlolra(a)gmail.com> Date: Sun Jul 7 12:43:32 2019 +0200 Don't specify port for stun server No idea why but, with it, when a client disconnects the datachannel doesn't close. This wasn't an issue prior to 359600d since the configuration wasn't being passed to the peerconnection constructor. This probably just makes the url invalid and falls back to a default in libwebrtc. --- proxy/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proxy/config.js b/proxy/config.js index 316f3b0..d5d8ef7 100644 --- a/proxy/config.js +++ b/proxy/config.js @@ -30,7 +30,7 @@ Config.prototype.connectionsPerClient = 1; Config.prototype.pcConfig = { iceServers: [ { - urls: ['stun:stun.l.google.com:19302'] + urls: ['stun:stun.l.google.com'] } ] };

1 0

[snowflake/master] Don't overwrite global location
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit 6e95581f53d5b20c699617b7f57fc8b285a3d9c7 Author: Arlo Breault <arlolra(a)gmail.com> Date: Sun Jul 7 10:30:19 2019 +0200 Don't overwrite global location --- proxy/init-badge.js | 2 +- proxy/shims.js | 5 +---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/proxy/init-badge.js b/proxy/init-badge.js index 09579e6..180a963 100644 --- a/proxy/init-badge.js +++ b/proxy/init-badge.js @@ -13,7 +13,7 @@ var snowflake, query, debug, silenceNotifications, log, dbg, init; snowflake = null; - query = Query.parse(location); + query = Query.parse(location.search.substr(1)); debug = Params.getBool(query, 'debug', false); diff --git a/proxy/shims.js b/proxy/shims.js index 4fc0b38..4ddf421 100644 --- a/proxy/shims.js +++ b/proxy/shims.js @@ -10,7 +10,7 @@ if (typeof module !== "undefined" && module !== null ? module.exports : void 0) } }; chrome = {}; - location = ''; + location = { search: '' }; if ((typeof TESTING === "undefined" || TESTING === null) || !TESTING) { webrtc = require('wrtc'); PeerConnection = webrtc.RTCPeerConnection; @@ -20,9 +20,6 @@ if (typeof module !== "undefined" && module !== null ? module.exports : void 0) ({ XMLHttpRequest } = require('xmlhttprequest')); } } else { - document = window.document; - chrome = window.chrome; - location = window.location.search.substr(1); PeerConnection = window.RTCPeerConnection || window.mozRTCPeerConnection || window.webkitRTCPeerConnection; IceCandidate = window.RTCIceCandidate || window.mozRTCIceCandidate; SessionDescription = window.RTCSessionDescription || window.mozRTCSessionDescription;

1 0

[snowflake/master] Null out relay after closing
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit c12fcbeb856fcb2ea5431059bd6712d91e5ac1b5 Author: Arlo Breault <arlolra(a)gmail.com> Date: Sun Jul 7 18:44:56 2019 +0200 Null out relay after closing This was probably meant to be `@relay = null` is the coffeescript. --- proxy/proxypair.js | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/proxy/proxypair.js b/proxy/proxypair.js index c162807..674ac18 100644 --- a/proxy/proxypair.js +++ b/proxy/proxypair.js @@ -121,18 +121,18 @@ class ProxyPair { if (peer_ip != null) { params.push(["client_ip", peer_ip]); } - this.relay = WS.makeWebsocket(this.relayAddr, params); + var relay = this.relay = WS.makeWebsocket(this.relayAddr, params); this.relay.label = 'websocket-relay'; this.relay.onopen = () => { if (this.timer) { clearTimeout(this.timer); this.timer = 0; } - log(this.relay.label + ' connected!'); + log(relay.label + ' connected!'); return snowflake.ui.setStatus('connected'); }; this.relay.onclose = () => { - log(this.relay.label + ' closed.'); + log(relay.label + ' closed.'); snowflake.ui.setStatus('disconnected.'); snowflake.ui.setActive(false); snowflake.state = Snowflake.MODE.INIT; @@ -146,8 +146,8 @@ class ProxyPair { if (0 === this.timer) { return; } - log(this.relay.label + ' timed out connecting.'); - return this.relay.onclose(); + log(relay.label + ' timed out connecting.'); + return relay.onclose(); }), 5000); } @@ -172,7 +172,6 @@ class ProxyPair { // Close both WebRTC and websocket. close() { - var relay; if (this.timer) { clearTimeout(this.timer); this.timer = 0; @@ -181,11 +180,12 @@ class ProxyPair { if (this.webrtcIsReady()) { this.client.close(); } + this.client = null; if (this.relayIsReady()) { this.relay.close(); } - relay = null; - return this.onCleanup(); + this.relay = null; + this.onCleanup(); } flush() {

1 0

[snowflake/master] Cleanup lints identified by eslint
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit fab39ae57c8c8ba0a65ec381e8b9678468e45164 Author: Arlo Breault <arlolra(a)gmail.com> Date: Sun Jul 7 15:40:51 2019 +0200 Cleanup lints identified by eslint Some files were omitted in the .eslintignore, left as an exercise to the reader. We probably want to reduce amount of globals overall and use proper es modules. --- proxy/.eslintignore | 7 +++++++ proxy/.eslintrc.json | 3 +-- proxy/broker.js | 4 +++- proxy/config.js | 2 +- proxy/init-badge.js | 4 +++- proxy/init-node.js | 2 ++ proxy/init-webext.js | 5 ++++- proxy/make.js | 13 ++++--------- proxy/proxypair.js | 8 ++++---- proxy/shims.js | 2 ++ proxy/snowflake.js | 10 ++++++---- proxy/spec/broker.spec.js | 2 ++ proxy/spec/init.spec.js | 2 ++ proxy/spec/proxypair.spec.js | 2 ++ proxy/spec/snowflake.spec.js | 20 +++++++++++--------- proxy/spec/ui.spec.js | 6 +++++- proxy/spec/util.spec.js | 2 ++ proxy/spec/websocket.spec.js | 2 ++ proxy/ui.js | 28 ++++++++++++++-------------- proxy/util.js | 17 ++++++++++------- proxy/webext/popup.js | 2 ++ proxy/websocket.js | 6 ++++-- 22 files changed, 93 insertions(+), 56 deletions(-) diff --git a/proxy/.eslintignore b/proxy/.eslintignore new file mode 100644 index 0000000..f580632 --- /dev/null +++ b/proxy/.eslintignore @@ -0,0 +1,7 @@ +build/ +test/ +webext/snowflake.js + +# FIXME: Whittle these away +spec/ +shims.js diff --git a/proxy/.eslintrc.json b/proxy/.eslintrc.json index d6f8309..f94ba96 100644 --- a/proxy/.eslintrc.json +++ b/proxy/.eslintrc.json @@ -1,8 +1,7 @@ { "env": { "browser": true, - "es6": true, - "node": true + "es6": true }, "extends": "eslint:recommended" } diff --git a/proxy/broker.js b/proxy/broker.js index 4e287b4..9806e76 100644 --- a/proxy/broker.js +++ b/proxy/broker.js @@ -1,3 +1,5 @@ +/* global log, dbg, snowflake */ + /* Communication with the snowflake broker. @@ -104,7 +106,7 @@ class Broker { return xhr.send(payload); } -}; +} Broker.STATUS = { OK: 200, diff --git a/proxy/config.js b/proxy/config.js index d5d8ef7..af8bc02 100644 --- a/proxy/config.js +++ b/proxy/config.js @@ -1,5 +1,5 @@ -class Config {}; +class Config {} Config.prototype.brokerUrl = 'snowflake-broker.bamsoftware.com'; diff --git a/proxy/init-badge.js b/proxy/init-badge.js index 180a963..1a887a1 100644 --- a/proxy/init-badge.js +++ b/proxy/init-badge.js @@ -1,10 +1,12 @@ +/* global TESTING, Util, Query, Params, Config, DebugUI, BadgeUI, UI, Broker, Snowflake */ + /* Entry point. */ var snowflake, query, debug, silenceNotifications, log, dbg, init; -;(function() { +(function() { if (((typeof TESTING === "undefined" || TESTING === null) || !TESTING) && !Util.featureDetect()) { console.log('webrtc feature not detected. shutting down'); diff --git a/proxy/init-node.js b/proxy/init-node.js index 9efd486..789e6e3 100644 --- a/proxy/init-node.js +++ b/proxy/init-node.js @@ -1,3 +1,5 @@ +/* global Config, UI, Broker, Snowflake */ + /* Entry point. */ diff --git a/proxy/init-webext.js b/proxy/init-webext.js index ee755c6..2f4f156 100644 --- a/proxy/init-webext.js +++ b/proxy/init-webext.js @@ -1,10 +1,13 @@ +/* global Util, chrome, Config, WebExtUI, Broker, Snowflake */ +/* eslint no-unused-vars: 0 */ + /* Entry point. */ var debug, snowflake, config, broker, ui, log, dbg, init, update, silenceNotifications; -;(function () { +(function () { silenceNotifications = false; debug = false; diff --git a/proxy/make.js b/proxy/make.js index f5f1c0a..b614864 100755 --- a/proxy/make.js +++ b/proxy/make.js @@ -1,7 +1,8 @@ #!/usr/bin/env node -var fs = require('fs'); -var { exec, spawn, execSync } = require('child_process'); +/* global require, process */ + +var { exec, spawn } = require('child_process'); // All files required. var FILES = [ @@ -15,12 +16,6 @@ var FILES = [ 'shims.js' ]; -var INITS = [ - 'init-badge.js', - 'init-node.js', - 'init-webext.js' -]; - var FILES_SPEC = [ 'spec/broker.spec.js', 'spec/init.spec.js', @@ -42,7 +37,7 @@ var copyStaticFiles = function() { var concatJS = function(outDir, init) { var files; files = FILES.concat(`init-${init}.js`); - return exec(`cat ${files.join(' ')} > ${outDir}/${OUTFILE}`, function(err, stdout, stderr) { + return exec(`cat ${files.join(' ')} > ${outDir}/${OUTFILE}`, function(err) { if (err) { throw err; } diff --git a/proxy/proxypair.js b/proxy/proxypair.js index 674ac18..6ffa9e5 100644 --- a/proxy/proxypair.js +++ b/proxy/proxypair.js @@ -1,3 +1,5 @@ +/* global snowflake, log, dbg, Util, PeerConnection, Snowflake, Parse, WS */ + /* Represents a single: @@ -66,15 +68,13 @@ class ProxyPair { } receiveWebRTCOffer(offer) { - var e, err; if ('offer' !== offer.type) { log('Invalid SDP received -- was not an offer.'); return false; } try { - err = this.pc.setRemoteDescription(offer); + this.pc.setRemoteDescription(offer); } catch (error) { - e = error; log('Invalid SDP message.'); return false; } @@ -233,7 +233,7 @@ class ProxyPair { return void 0 === ws || WebSocket.CLOSED === ws.readyState; } -}; +} ProxyPair.prototype.MAX_BUFFER = 10 * 1024 * 1024; diff --git a/proxy/shims.js b/proxy/shims.js index 4ddf421..8c88eae 100644 --- a/proxy/shims.js +++ b/proxy/shims.js @@ -1,3 +1,5 @@ +/* global module, require */ + /* WebRTC shims for multiple browsers. */ diff --git a/proxy/snowflake.js b/proxy/snowflake.js index 2c08c4d..bbf3d8b 100644 --- a/proxy/snowflake.js +++ b/proxy/snowflake.js @@ -1,3 +1,5 @@ +/* global log, dbg, DummyRateLimit, BucketRateLimit, SessionDescription, ProxyPair */ + /* A JavaScript WebRTC snowflake proxy @@ -79,7 +81,7 @@ class Snowflake { } else { return pair.active = false; } - }, function(err) { + }, function() { return pair.active = false; }); return this.retries++; @@ -90,7 +92,7 @@ class Snowflake { if (this.proxyPairs.length < this.config.connectionsPerClient) { return this.makeProxyPair(this.relayAddr); } - return this.proxyPairs.find(function(pp, i, arr) { + return this.proxyPairs.find(function(pp) { return !pp.active; }); } @@ -130,7 +132,7 @@ class Snowflake { var pair; pair = new ProxyPair(relay, this.rateLimit, this.config.pcConfig); this.proxyPairs.push(pair); - pair.onCleanup = (event) => { + pair.onCleanup = () => { var ind; // Delete from the list of active proxy pairs. ind = this.proxyPairs.indexOf(pair); @@ -154,7 +156,7 @@ class Snowflake { return results; } -}; +} Snowflake.prototype.relayAddr = null; diff --git a/proxy/spec/broker.spec.js b/proxy/spec/broker.spec.js index a7c2e1d..4eb3029 100644 --- a/proxy/spec/broker.spec.js +++ b/proxy/spec/broker.spec.js @@ -1,3 +1,5 @@ +/* global expect, it, describe, spyOn, Broker */ + /* jasmine tests for Snowflake broker */ diff --git a/proxy/spec/init.spec.js b/proxy/spec/init.spec.js index baa7388..748bc86 100644 --- a/proxy/spec/init.spec.js +++ b/proxy/spec/init.spec.js @@ -1,3 +1,5 @@ +/* global expect, it, describe, Snowflake, UI */ + // Fake snowflake to interact with var snowflake = { diff --git a/proxy/spec/proxypair.spec.js b/proxy/spec/proxypair.spec.js index 924aca0..3716f2d 100644 --- a/proxy/spec/proxypair.spec.js +++ b/proxy/spec/proxypair.spec.js @@ -1,3 +1,5 @@ +/* global expect, it, describe, spyOn */ + /* jasmine tests for Snowflake proxypair */ diff --git a/proxy/spec/snowflake.spec.js b/proxy/spec/snowflake.spec.js index eccc24d..970947b 100644 --- a/proxy/spec/snowflake.spec.js +++ b/proxy/spec/snowflake.spec.js @@ -1,3 +1,5 @@ +/* global expect, it, describe, spyOn, Snowflake, Config, UI */ + /* jasmine tests for Snowflake */ @@ -7,34 +9,34 @@ class PeerConnection { setRemoteDescription() { return true; } - send(data) {} -}; + send() {} +} -class SessionDescription {}; +class SessionDescription {} SessionDescription.prototype.type = 'offer'; class WebSocket { constructor() { this.bufferedAmount = 0; } - send(data) {} -}; + send() {} +} WebSocket.prototype.OPEN = 1; WebSocket.prototype.CLOSED = 0; var log = function() {}; -var config = new Config; +var config = new Config(); -var ui = new UI; +var ui = new UI(); class FakeBroker { getClientOffer() { - return new Promise(function(F, R) { + return new Promise(function() { return {}; }); } -}; +} describe('Snowflake', function() { diff --git a/proxy/spec/ui.spec.js b/proxy/spec/ui.spec.js index 8ae141f..3386a2d 100644 --- a/proxy/spec/ui.spec.js +++ b/proxy/spec/ui.spec.js @@ -1,8 +1,12 @@ +/* global expect, it, describe, spyOn, DebugUI, BadgeUI */ +/* eslint no-redeclare: 0 */ + /* jasmine tests for Snowflake UI */ + var document = { - getElementById: function(id) { + getElementById: function() { return {}; }, createTextNode: function(txt) { diff --git a/proxy/spec/util.spec.js b/proxy/spec/util.spec.js index 8f1ff7a..17968b1 100644 --- a/proxy/spec/util.spec.js +++ b/proxy/spec/util.spec.js @@ -1,3 +1,5 @@ +/* global expect, it, describe, Parse, Query, Params */ + /* jasmine tests for Snowflake utils */ diff --git a/proxy/spec/websocket.spec.js b/proxy/spec/websocket.spec.js index 370995a..6c2ef2e 100644 --- a/proxy/spec/websocket.spec.js +++ b/proxy/spec/websocket.spec.js @@ -1,3 +1,5 @@ +/* global expect, it, describe, WS */ + /* jasmine tests for Snowflake websocket */ diff --git a/proxy/ui.js b/proxy/ui.js index da14800..54e0897 100644 --- a/proxy/ui.js +++ b/proxy/ui.js @@ -1,18 +1,20 @@ +/* global chrome, log, update */ + /* All of Snowflake's DOM manipulation and inputs. */ class UI { - setStatus(msg) {} + setStatus() {} setActive(connected) { return this.active = connected; } - log(msg) {} + log() {} -}; +} UI.prototype.active = false; @@ -31,7 +33,7 @@ class BadgeUI extends UI { return this.$badge.className = connected ? 'active' : ''; } -}; +} BadgeUI.prototype.$badge = null; @@ -67,7 +69,7 @@ class DebugUI extends UI { return this.$msglog.scrollTop = this.$msglog.scrollHeight; } -}; +} // DOM elements references. DebugUI.prototype.$msglog = null; @@ -96,14 +98,13 @@ class WebExtUI extends UI { } initToggle() { - var getting; - return getting = chrome.storage.local.get("snowflake-enabled", (result) => { + chrome.storage.local.get("snowflake-enabled", (result) => { if (result['snowflake-enabled'] !== void 0) { this.enabled = result['snowflake-enabled']; } else { log("Toggle state not yet saved"); } - return this.setEnabled(this.enabled); + this.setEnabled(this.enabled); }); } @@ -126,19 +127,18 @@ class WebExtUI extends UI { } onMessage(m) { - var storing; this.enabled = m.enabled; this.setEnabled(this.enabled); this.postActive(); - return storing = chrome.storage.local.set({ + chrome.storage.local.set({ "snowflake-enabled": this.enabled }, function() { - return log("Stored toggle state"); + log("Stored toggle state"); }); } - onDisconnect(port) { - return this.port = null; + onDisconnect() { + this.port = null; } setActive(connected) { @@ -171,7 +171,7 @@ class WebExtUI extends UI { }); } -}; +} WebExtUI.prototype.port = null; diff --git a/proxy/util.js b/proxy/util.js index 6d3651f..073251e 100644 --- a/proxy/util.js +++ b/proxy/util.js @@ -1,3 +1,6 @@ +/* global log */ +/* exported Query, Params, DummyRateLimit */ + /* A JavaScript WebRTC snowflake proxy @@ -34,7 +37,7 @@ class Util { return typeof PeerConnection === 'function'; } -}; +} // It would not be effective for Tor Browser users to run the proxy. // Do we seem to be running in Tor Browser? Check the user-agent string and for @@ -99,7 +102,7 @@ class Query { return parts.join('&'); } -}; +} class Parse { @@ -203,7 +206,7 @@ class Parse { } } -}; +} class Params { @@ -257,7 +260,7 @@ class Params { return val; } -}; +} class BucketRateLimit { @@ -295,7 +298,7 @@ class BucketRateLimit { return this.amount > this.capacity; } -}; +} BucketRateLimit.prototype.amount = 0.0; @@ -310,7 +313,7 @@ class DummyRateLimit { this.time = time; } - update(n) { + update() { return true; } @@ -322,4 +325,4 @@ class DummyRateLimit { return false; } -}; +} diff --git a/proxy/webext/popup.js b/proxy/webext/popup.js index 435adb1..d8d6464 100644 --- a/proxy/webext/popup.js +++ b/proxy/webext/popup.js @@ -1,3 +1,5 @@ +/* global chrome */ + const port = chrome.runtime.connect({ name: "popup" }); diff --git a/proxy/websocket.js b/proxy/websocket.js index 2a124aa..83911da 100644 --- a/proxy/websocket.js +++ b/proxy/websocket.js @@ -1,3 +1,5 @@ +/* global Query */ + /* Only websocket-specific stuff. */ @@ -27,7 +29,7 @@ class WS { if (!path.match(/^\//)) { path = '/' + path; } - path = path.replace(/[^\/]+/, function(m) { + path = path.replace(/[^/]+/, function(m) { return encodeURIComponent(m); }); parts.push(path); @@ -54,7 +56,7 @@ class WS { return ws; } -}; +} WS.WSS_ENABLED = true;

1 0

[snowflake/master] Lint with eslint
by arlo＠torproject.org 10 Jul '19

10 Jul '19

commit ebeb45c8d621dbeb2c9d0cbe06669ad3751b3ea4 Author: Arlo Breault <arlolra(a)gmail.com> Date: Sun Jul 7 15:31:09 2019 +0200 Lint with eslint Requires at least node v8.x --- .travis.yml | 3 ++- proxy/.eslintrc.json | 8 ++++++++ proxy/package.json | 4 +++- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 259d9eb..072f073 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,7 +16,7 @@ go: - 1.10.x env: - - TRAVIS_NODE_VERSION="6" CC="gcc-5" CXX="g++-5" + - TRAVIS_NODE_VERSION="8" CC="gcc-5" CXX="g++-5" before_install: - nvm install $TRAVIS_NODE_VERSION @@ -39,4 +39,5 @@ script: - go vet ./... - go test -v -race ./... - cd proxy + - npm run lint - npm test diff --git a/proxy/.eslintrc.json b/proxy/.eslintrc.json new file mode 100644 index 0000000..d6f8309 --- /dev/null +++ b/proxy/.eslintrc.json @@ -0,0 +1,8 @@ +{ + "env": { + "browser": true, + "es6": true, + "node": true + }, + "extends": "eslint:recommended" +} diff --git a/proxy/package.json b/proxy/package.json index ca13a52..c5a571b 100644 --- a/proxy/package.json +++ b/proxy/package.json @@ -12,7 +12,8 @@ "webext": "node make.js webext", "clean": "node make.js clean", "prepublish": "node make.js node", - "start": "node build/snowflake.js" + "start": "node build/snowflake.js", + "lint": "eslint . --ext .js" }, "bin": { "snowflake": "build/snowflake.js" @@ -20,6 +21,7 @@ "author": "Serene Han", "license": "BSD-3-Clause", "devDependencies": { + "eslint": "^6.0.1", "jasmine": "2.5.2" }, "dependencies": {

1 0