2
0
mirror of https://git.coolaj86.com/coolaj86/telebit-relay.js.git synced 2025-04-21 11:00:37 +00:00

Compare commits

..

20 Commits

Author SHA1 Message Date
07965d8eac move tls-unwrapping (it may be sharable with client) 2018-04-25 17:41:20 +00:00
98d31fc8d7 v0.10.0 2018-04-24 16:36:04 +00:00
986102c79e Merge branch 'master' of ssh://git.coolaj86.com:22042/coolaj86/tunnel-server.js 2018-04-24 16:35:12 +00:00
4a2199dc71 begin install script 2018-04-24 16:34:51 +00:00
6b25c7e1f5 updated for node v8.x and ws 5.x 2018-04-24 16:34:20 +00:00
7f3c8ee96d update links 2018-04-24 01:53:27 +00:00
2b62ac2109 update links 2018-04-24 01:53:11 +00:00
c300636477 node node v9x bug 2018-04-24 01:49:56 +00:00
89718a8a07 v0.9.2 2018-04-21 01:19:57 +00:00
AJ ONeal
64eec91d11 update README.md 2018-02-14 23:22:23 -07:00
AJ ONeal
ae91fd5049 add stunneld.service for systemd 2017-10-04 17:37:07 -06:00
AJ ONeal
061999cc34 make error messages hyper-focused and super specific 2017-10-04 17:28:38 -06:00
tigerbot
68e5116ba0 v0.9.1 2017-09-11 16:02:20 -06:00
tigerbot
6fa7f50894 improved how throttling based on the websocket works 2017-09-11 15:45:17 -06:00
tigerbot
a8be74d77e went back to not allowing half-open connections 2017-09-08 11:24:30 -06:00
tigerbot
96ab344b71 implemented throttling when we buffer too much data 2017-09-07 17:10:47 -06:00
tigerbot
bbdb09902b changed way we close connections to support half-open 2017-09-06 18:43:34 -06:00
tigerbot
d013de932f make sure ports are numbers and domain names are lowercase 2017-09-06 18:41:26 -06:00
tigerbot
701aa99a30 added protection against unwanted writes to websocket 2017-06-22 13:18:39 -06:00
tigerbot
aff82cebe9 made it possible to check if domain is handled as client 2017-06-21 18:55:24 -06:00
10 changed files with 446 additions and 276 deletions

View File

@ -1,21 +1,7 @@
<!-- BANNER_TPL_BEGIN --> | Sponsored by [ppl](https://ppl.family) | **tunnel-server.js** | [tunnel-client.js](https://git.coolaj86.com/coolaj86/tunnel-client.js) |
About Daplie: We're taking back the Internet!
--------------
Down with Google, Apple, and Facebook!
We're re-decentralizing the web and making it read-write again - one home cloud system at a time.
Tired of serving the Empire? Come join the Rebel Alliance:
<a href="mailto:jobs@daplie.com">jobs@daplie.com</a> | [Invest in Daplie on Wefunder](https://daplie.com/invest/) | [Pre-order Cloud](https://daplie.com/preorder/), The World's First Home Server for Everyone
<!-- BANNER_TPL_END -->
# stunneld.js # stunneld.js
A server that works in combination with [stunnel.js](https://github.com/Daplie/node-tunnel-client) A server that works in combination with [stunnel.js](https://git.coolaj86.com/coolaj86/tunnel-client.js)
to allow you to serve http and https from any computer, anywhere through a secure tunnel. to allow you to serve http and https from any computer, anywhere through a secure tunnel.
CLI CLI
@ -30,6 +16,17 @@ Installs as `stunnel.js` with the alias `jstunnel`
npm install -g stunneld npm install -g stunneld
``` ```
Then `dist/etc/systemd/system/stunneld.service` should be copied to `/etc/systemd/system/stunneld.service` and
the ARGUMENTS, such as SECRET, MUST BE CHANGED.
*TODO*: make `--config /path/to/config` the only argument (and have the secret auto-generated on first run?)
## Note: Use node.js v8.x
There is a bug in node v9.x that causes stunneld to crash.
https://github.com/nodejs/node/issues/20241
### Advanced Usage ### Advanced Usage
How to use `stunnel.js` with your own instance of `stunneld.js`: How to use `stunnel.js` with your own instance of `stunneld.js`:
@ -62,11 +59,11 @@ but those generally cost $5 - $20 / month and so it's probably
cheaper to purchase data transfer (which we supply, obviously), cheaper to purchase data transfer (which we supply, obviously),
which is only $1/month for most people. which is only $1/month for most people.
Just use the client ([stunnel.js](https://github.com/Daplie/node-tunnel-client)) Just use the client ([stunnel.js](https://git.coolaj86.com/coolaj86/tunnel-client.js))
with Daplie's tunneling service (the default) and save yourself the monthly fee with this tunneling service (the default) and save yourself the monthly fee
by only paying for the data you need. by only paying for the data you need.
* Daplie Tunnel (zero setup) * Node WS Tunnel (zero setup)
* Heroku (zero cost) * Heroku (zero cost)
* Chunk Host (best deal per TB/month) * Chunk Host (best deal per TB/month)

4
bin/generate-secret.js Executable file
View File

@ -0,0 +1,4 @@
#!/usr/bin/env node
'use strict'
console.log(require('crypto').randomBytes(16).toString('hex'));

View File

@ -0,0 +1,13 @@
#!/bin/bash
rm -rf ./node-installer.sh
curl -fsSL bit.ly/node-installer -o ./node-installer.sh
bash ./node-installer.sh --dev-deps
git clone https://git.coolaj86.com/coolaj86/tunnel-server.js.git
pushd tunnel-server.js/
npm install
my_secret=$(node bin/generate-secret.js)
echo "Your secret is:\n\n\t"$my_secret
echo "node bin/server.js --servernames tunnel.example.com --secret $my_secret"
popd

View File

@ -9,11 +9,11 @@ var stunneld = require('../wstunneld.js');
var greenlock = require('greenlock'); var greenlock = require('greenlock');
function collectServernames(val, memo) { function collectServernames(val, memo) {
val.split(/,/).forEach(function (servername) { var lowerCase = val.split(/,/).map(function (servername) {
memo.push(servername.toLowerCase()); return servername.toLowerCase();
}); });
return memo; return memo.concat(lowerCase);
} }
function collectProxies(val, memo) { function collectProxies(val, memo) {
@ -65,8 +65,7 @@ function collectProxies(val, memo) {
} }
function collectPorts(val, memo) { function collectPorts(val, memo) {
memo = memo.concat(val.split(/,/g).filter(Boolean)); return memo.concat(val.split(/,/g).map(Number).filter(Boolean));
return memo;
} }
program program
@ -97,7 +96,7 @@ program.ports.forEach(function (port) {
program.servernames = Object.keys(servernamesMap); program.servernames = Object.keys(servernamesMap);
if (!program.servernames.length) { if (!program.servernames.length) {
throw new Error('must specify at least one server or servername'); throw new Error('You must give this server at least one servername for its admin interface. Example:\n\n\t--servernames tunnel.example.com,tunnel.example.net');
} }
program.ports = Object.keys(portsMap); program.ports = Object.keys(portsMap);
@ -146,8 +145,8 @@ if (!program.email || !program.agreeTos) {
else { else {
program.greenlock = greenlock.create({ program.greenlock = greenlock.create({
//server: 'staging' version: 'draft-11'
server: 'https://acme-v01.api.letsencrypt.org/directory' , server: 'https://acme-v02.api.letsencrypt.org/directory'
, challenges: { , challenges: {
// TODO dns-01 // TODO dns-01

View File

@ -0,0 +1,23 @@
[Unit]
Description=Daplie Tunnel Server
After=network-online.target
Wants=network-online.target systemd-networkd-wait-online.service
[Service]
# Always restart, unless it's restarting fast enough for us to believe it's completely broken
Restart=always
StartLimitInterval=10
StartLimitBurst=3
User=www-data
Group=www-data
WorkingDirectory=/srv/stunneld
# TODO needs --config option and these options should go in a config file
ExecStart=/srv/stunneld/bin/stunneld.js --servernames tunnel.example.com --secret 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --email tunnel@example.com --agree-tos
CapabilityBoundingSet=CAP_NET_BIND_SERVICE
AmbientCapabilities=CAP_NET_BIND_SERVICE
NoNewPrivileges=true
[Install]
WantedBy=multi-user.target

View File

@ -44,7 +44,7 @@ module.exports.create = function (program) {
// SNI is not recogonized / cannot be handled // SNI is not recogonized / cannot be handled
// //
program.httpInvalidSniServer = http.createServer(function (req, res) { program.httpInvalidSniServer = http.createServer(function (req, res) {
res.end("You're doing strange things that make me feel uncomfortable. Please don't touch me there any more."); res.end("This is an old error message that shouldn't be actually be acessible anymore. If you get this please tell AJ so that he finds where it was still referenced and removes it");
}); });
program.tlsInvalidSniServer = tls.createServer(program.tlsOptions, function (tlsSocket) { program.tlsInvalidSniServer = tls.createServer(program.tlsOptions, function (tlsSocket) {
console.log('tls connection'); console.log('tls connection');
@ -58,7 +58,33 @@ module.exports.create = function (program) {
//console.log('chunkLen', firstChunk.byteLength); //console.log('chunkLen', firstChunk.byteLength);
console.log('httpsInvalid servername', servername); console.log('httpsInvalid servername', servername);
program.tlsInvalidSniServer.emit('connection', wrapSocket(socket)); //program.tlsInvalidSniServer.emit('connection', wrapSocket(socket));
var tlsInvalidSniServer = tls.createServer(program.tlsOptions, function (tlsSocket) {
console.log('tls connection');
// things get a little messed up here
var httpInvalidSniServer = http.createServer(function (req, res) {
if (!servername) {
res.statusCode = 422;
res.end(
"3. An inexplicable temporal shift of the quantum realm... that makes me feel uncomfortable.\n\n"
+ "[ERROR] No SNI header was sent. I can only think of two possible explanations for this:\n"
+ "\t1. You really love Windows XP and you just won't let go of Internet Explorer 6\n"
+ "\t2. You're writing a bot and you forgot to set the servername parameter\n"
);
return;
}
res.end(
"You came in hot looking for '" + servername + "' and, granted, the IP address for that domain"
+ " must be pointing here (or else how could you be here?), nevertheless either it's not registered"
+ " in the internal system at all (which Seth says isn't even a thing) or there is no device"
+ " connected on the south side of the network which has informed me that it's ready to have traffic"
+ " for that domain forwarded to it (sorry I didn't check that deeply to determine which).\n\n"
+ "Either way, you're doing strange things that make me feel uncomfortable... Please don't touch me there any more.");
});
httpInvalidSniServer.emit('connection', tlsSocket);
});
tlsInvalidSniServer.emit('connection', wrapSocket(socket));
}; };
// //

55
lib/device-tracker.js Normal file
View File

@ -0,0 +1,55 @@
'use strict';
var Devices = module.exports;
Devices.add = function (store, servername, newDevice) {
var devices = store[servername] || [];
devices.push(newDevice);
store[servername] = devices;
};
Devices.remove = function (store, servername, device) {
var devices = store[servername] || [];
var index = devices.indexOf(device);
if (index < 0) {
console.warn('attempted to remove non-present device', device.deviceId, 'from', servername);
return null;
}
return devices.splice(index, 1)[0];
};
Devices.list = function (store, servername) {
if (store[servername] && store[servername].length) {
return store[servername];
}
// There wasn't an exact match so check any of the wildcard domains, sorted longest
// first so the one with the biggest natural match with be found first.
var deviceList = [];
Object.keys(store).filter(function (pattern) {
return pattern[0] === '*' && store[pattern].length;
}).sort(function (a, b) {
return b.length - a.length;
}).some(function (pattern) {
var subPiece = pattern.slice(1);
if (subPiece === servername.slice(-subPiece.length)) {
console.log('"'+servername+'" matches "'+pattern+'"');
deviceList = store[pattern];
return true;
}
});
return deviceList;
};
Devices.exist = function (store, servername) {
return !!(Devices.list(store, servername).length);
};
Devices.next = function (store, servername) {
var devices = Devices.list(store, servername);
var device;
if (devices._index >= devices.length) {
devices._index = 0;
}
device = devices[devices._index || 0];
devices._index = (devices._index || 0) + 1;
return device;
};

153
lib/unwrap-tls.js Normal file
View File

@ -0,0 +1,153 @@
'use strict';
var packer = require('tunnel-packer');
var sni = require('sni');
function pipeWs(servername, service, conn, remote) {
console.log('[pipeWs] servername:', servername, 'service:', service);
var browserAddr = packer.socketToAddr(conn);
browserAddr.service = service;
var cid = packer.addrToId(browserAddr);
conn.tunnelCid = cid;
console.log('[pipeWs] browser is', cid, 'home-cloud is', packer.socketToId(remote.upgradeReq.socket));
function sendWs(data, serviceOverride) {
if (remote.ws && (!conn.tunnelClosing || serviceOverride)) {
try {
remote.ws.send(packer.pack(browserAddr, data, serviceOverride), { binary: true });
// If we can't send data over the websocket as fast as this connection can send it to us
// (or there are a lot of connections trying to send over the same websocket) then we
// need to pause the connection for a little. We pause all connections if any are paused
// to make things more fair so a connection doesn't get stuck waiting for everyone else
// to finish because it got caught on the boundary. Also if serviceOverride is set it
// means the connection is over, so no need to pause it.
if (!serviceOverride && (remote.pausedConns.length || remote.ws.bufferedAmount > 1024*1024)) {
// console.log('pausing', cid, 'to allow web socket to catch up');
conn.pause();
remote.pausedConns.push(conn);
}
} catch (err) {
console.warn('[pipeWs] error sending websocket message', err);
}
}
}
remote.clients[cid] = conn;
conn.on('data', function (chunk) {
console.log('[pipeWs] data from browser to tunneler', chunk.byteLength);
sendWs(chunk);
});
conn.on('error', function (err) {
console.warn('[pipeWs] browser connection error', err);
});
conn.on('close', function (hadErr) {
console.log('[pipeWs] browser connection closing');
sendWs(null, hadErr ? 'error': 'end');
delete remote.clients[cid];
});
}
module.exports.createTcpConnectionHandler = function (copts) {
var Devices = copts.Devices;
return function onTcpConnection(conn) {
// this works when I put it here, but I don't know if it's tls yet here
// httpsServer.emit('connection', socket);
//tls3000.emit('connection', socket);
//var tlsSocket = new tls.TLSSocket(socket, { secureContext: tls.createSecureContext(tlsOpts) });
//tlsSocket.on('data', function (chunk) {
// console.log('dummy', chunk.byteLength);
//});
//return;
conn.once('data', function (firstChunk) {
// BUG XXX: this assumes that the packet won't be chunked smaller
// than the 'hello' or the point of the 'Host' header.
// This is fairly reasonable, but there are edge cases where
// it does not hold (such as manual debugging with telnet)
// and so it should be fixed at some point in the future
// defer after return (instead of being in many places)
process.nextTick(function () {
conn.unshift(firstChunk);
});
var service = 'tcp';
var servername;
var str;
var m;
function tryTls() {
if (-1 !== copts.servernames.indexOf(servername)) {
console.log("Lock and load, admin interface time!");
copts.httpsTunnel(servername, conn);
return;
}
if (!servername) {
console.log("No SNI was given, so there's nothing we can do here");
copts.httpsInvalid(servername, conn);
return;
}
var nextDevice = Devices.next(copts.deviceLists, servername);
if (!nextDevice) {
console.log("No devices match the given servername");
copts.httpsInvalid(servername, conn);
return;
}
console.log("pipeWs(servername, service, socket, deviceLists['" + servername + "'])");
pipeWs(servername, service, conn, nextDevice);
}
// https://github.com/mscdex/httpolyglot/issues/3#issuecomment-173680155
if (22 === firstChunk[0]) {
// TLS
service = 'https';
servername = (sni(firstChunk)||'').toLowerCase();
console.log("tls hello servername:", servername);
tryTls();
return;
}
if (firstChunk[0] > 32 && firstChunk[0] < 127) {
str = firstChunk.toString();
m = str.match(/(?:^|[\r\n])Host: ([^\r\n]+)[\r\n]*/im);
servername = (m && m[1].toLowerCase() || '').split(':')[0];
console.log('servername', servername);
if (/HTTP\//i.test(str)) {
service = 'http';
// TODO disallow http entirely
// /^\/\.well-known\/acme-challenge\//.test(str)
if (/well-known/.test(str)) {
// HTTP
if (Devices.exist(copts.deviceLists, servername)) {
pipeWs(servername, service, conn, Devices.next(copts.deviceLists, servername));
return;
}
copts.handleHttp(servername, conn);
}
else {
// redirect to https
copts.handleInsecureHttp(servername, conn);
}
return;
}
}
console.error("Got unexpected connection", str);
conn.write(JSON.stringify({ error: {
message: "not sure what you were trying to do there..."
, code: 'E_INVALID_PROTOCOL' }
}));
conn.end();
});
conn.on('error', function (err) {
console.error('[error] tcp socket raw TODO forward and close');
console.error(err);
});
};
};

View File

@ -1,6 +1,6 @@
{ {
"name": "stunneld", "name": "stunneld",
"version": "0.9.0", "version": "0.10.0",
"description": "A pure-JavaScript tunnel daemon for http and https similar to a localtunnel.me server, but uses TLS (SSL) with ServerName Indication (SNI) over https to work even in harsh network conditions such as in student dorms and behind HOAs, corporate firewalls, public libraries, airports, airplanes, etc. Can also tunnel tls and plain tcp.", "description": "A pure-JavaScript tunnel daemon for http and https similar to a localtunnel.me server, but uses TLS (SSL) with ServerName Indication (SNI) over https to work even in harsh network conditions such as in student dorms and behind HOAs, corporate firewalls, public libraries, airports, airplanes, etc. Can also tunnel tls and plain tcp.",
"main": "wstunneld.js", "main": "wstunneld.js",
"bin": { "bin": {
@ -13,7 +13,7 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/Daplie/node-tunnel-server.git" "url": "git+https://git.coolaj86.com/coolaj86/tunnel-server.js.git"
}, },
"keywords": [ "keywords": [
"server", "server",
@ -42,19 +42,19 @@
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)", "author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
"license": "(MIT OR Apache-2.0)", "license": "(MIT OR Apache-2.0)",
"bugs": { "bugs": {
"url": "https://github.com/Daplie/node-tunnel-server/issues" "url": "https://git.coolaj86.com/coolaj86/tunnel-server.js/issues"
}, },
"homepage": "https://github.com/Daplie/node-tunnel-server#readme", "homepage": "https://git.coolaj86.com/coolaj86/tunnel-server.js",
"dependencies": { "dependencies": {
"bluebird": "^3.5.0", "bluebird": "^3.5.1",
"cluster-store": "^2.0.4", "cluster-store": "^2.0.8",
"commander": "^2.9.0", "commander": "^2.15.1",
"greenlock": "^2.1.12", "greenlock": "^2.2.4",
"jsonwebtoken": "^7.1.9", "jsonwebtoken": "^8.2.1",
"localhost.daplie.me-certificates": "^1.3.3", "localhost.daplie.me-certificates": "^1.3.5",
"redirect-https": "^1.1.0", "redirect-https": "^1.1.5",
"sni": "^1.0.0", "sni": "^1.0.0",
"tunnel-packer": "^1.3.0", "tunnel-packer": "^1.4.0",
"ws": "^2.2.3" "ws": "^5.1.1"
} }
} }

View File

@ -1,6 +1,5 @@
'use strict'; 'use strict';
var sni = require('sni');
var url = require('url'); var url = require('url');
var PromiseA = require('bluebird'); var PromiseA = require('bluebird');
var jwt = require('jsonwebtoken'); var jwt = require('jsonwebtoken');
@ -12,68 +11,20 @@ function timeoutPromise(duration) {
}); });
} }
var Devices = {}; var Devices = require('./lib/device-tracker');
Devices.add = function (store, servername, newDevice) {
var devices = store[servername] || [];
devices.push(newDevice);
store[servername] = devices;
};
Devices.remove = function (store, servername, device) {
var devices = store[servername] || [];
var index = devices.indexOf(device);
if (index < 0) {
console.warn('attempted to remove non-present device', device.deviceId, 'from', servername);
return null;
}
return devices.splice(index, 1)[0];
};
Devices.list = function (store, servername) {
if (store[servername] && store[servername].length) {
return store[servername];
}
// There wasn't an exact match so check any of the wildcard domains, sorted longest
// first so the one with the biggest natural match with be found first.
var deviceList = [];
Object.keys(store).filter(function (pattern) {
return pattern[0] === '*' && store[pattern].length;
}).sort(function (a, b) {
return b.length - a.length;
}).some(function (pattern) {
var subPiece = pattern.slice(1);
if (subPiece === servername.slice(-subPiece.length)) {
console.log('"'+servername+'" matches "'+pattern+'"');
deviceList = store[pattern];
return true;
}
});
return deviceList;
};
Devices.exist = function (store, servername) {
return !!(Devices.list(store, servername).length);
};
Devices.next = function (store, servername) {
var devices = Devices.list(store, servername);
var device;
if (devices._index >= devices.length) {
devices._index = 0;
}
device = devices[devices._index || 0];
devices._index = (devices._index || 0) + 1;
return device;
};
module.exports.store = { Devices: Devices }; module.exports.store = { Devices: Devices };
module.exports.create = function (copts) { module.exports.create = function (copts) {
var deviceLists = {}; copts.deviceLists = {};
//var deviceLists = {};
var activityTimeout = copts.activityTimeout || 2*60*1000; var activityTimeout = copts.activityTimeout || 2*60*1000;
var pongTimeout = copts.pongTimeout || 10*1000; var pongTimeout = copts.pongTimeout || 10*1000;
copts.Devices = Devices;
var onTcpConnection = require('./lib/unwrap-tls').createTcpConnectionHandler(copts);
function onWsConnection(ws) { function onWsConnection(ws, upgradeReq) {
var socketId = packer.socketToId(ws.upgradeReq.socket); console.log(ws);
var socketId = packer.socketToId(upgradeReq.socket);
var remotes = {}; var remotes = {};
function logName() { function logName() {
@ -83,7 +34,21 @@ module.exports.create = function (copts) {
return result || socketId; return result || socketId;
} }
function sendTunnelMsg(addr, data, service) {
ws.send(packer.pack(addr, data, service), {binary: true});
}
function getBrowserConn(cid) {
var browserConn;
Object.keys(remotes).some(function (jwtoken) {
if (remotes[jwtoken].clients[cid]) {
browserConn = remotes[jwtoken].clients[cid];
return true;
}
});
return browserConn;
}
function closeBrowserConn(cid) { function closeBrowserConn(cid) {
var remote; var remote;
Object.keys(remotes).some(function (jwtoken) { Object.keys(remotes).some(function (jwtoken) {
@ -96,28 +61,38 @@ module.exports.create = function (copts) {
return; return;
} }
PromiseA.resolve() PromiseA.resolve().then(function () {
.then(function () { var conn = remote.clients[cid];
remote.clients[cid].end(); conn.tunnelClosing = true;
conn.end();
// If no data is buffered for writing then we don't need to wait for it to drain.
if (!conn.bufferSize) {
return timeoutPromise(500); return timeoutPromise(500);
}) }
.then(function () { // Otherwise we want the connection to be able to finish, but we also want to impose
// a time limit for it to drain, since it shouldn't have more than 1MB buffered.
return new PromiseA(function (resolve) {
var timeoutId = setTimeout(resolve, 60*1000);
conn.once('drain', function () {
clearTimeout(timeoutId);
setTimeout(resolve, 500);
});
});
}).then(function () {
if (remote.clients[cid]) { if (remote.clients[cid]) {
console.warn(cid, 'browser connection still present after calling `end`'); console.warn(cid, 'browser connection still present after calling `end`');
remote.clients[cid].destroy(); remote.clients[cid].destroy();
return timeoutPromise(500); return timeoutPromise(500);
} }
}) }).then(function () {
.then(function () {
if (remote.clients[cid]) { if (remote.clients[cid]) {
console.error(cid, 'browser connection still present after calling `destroy`'); console.error(cid, 'browser connection still present after calling `destroy`');
delete remote.clients[cid]; delete remote.clients[cid];
} }
}) }).catch(function (err) {
.catch(function (err) {
console.warn('failed to close browser connection', cid, err); console.warn('failed to close browser connection', cid, err);
}) });
;
} }
function addToken(jwtoken) { function addToken(jwtoken) {
@ -154,11 +129,32 @@ module.exports.create = function (copts) {
// domains and the list of all this websocket's remotes. // domains and the list of all this websocket's remotes.
token.deviceId = (token.device && (token.device.id || token.device.hostname)) || token.domains.join(','); token.deviceId = (token.device && (token.device.id || token.device.hostname)) || token.domains.join(',');
token.ws = ws; token.ws = ws;
token.upgradeReq = upgradeReq;
token.clients = {}; token.clients = {};
token.pausedConns = [];
ws._socket.on('drain', function () {
// the websocket library has it's own buffer apart from node's socket buffer, but that one
// is much more difficult to watch, so we watch for the lower level buffer to drain and
// then check to see if the upper level buffer is still too full to write to. Note that
// the websocket library buffer has something to do with compression, so I'm not requiring
// that to be 0 before we start up again.
if (ws.bufferedAmount > 128*1024) {
return;
}
token.pausedConns.forEach(function (conn) {
if (!conn.manualPause) {
// console.log('resuming', conn.tunnelCid, 'now that the web socket has caught up');
conn.resume();
}
});
token.pausedConns.length = 0;
});
token.domains.forEach(function (domainname) { token.domains.forEach(function (domainname) {
console.log('domainname', domainname); console.log('domainname', domainname);
Devices.add(deviceLists, domainname, token); Devices.add(copts.deviceLists, domainname, token);
}); });
remotes[jwtoken] = token; remotes[jwtoken] = token;
console.log("added token '" + token.deviceId + "' to websocket", socketId); console.log("added token '" + token.deviceId + "' to websocket", socketId);
@ -174,9 +170,10 @@ module.exports.create = function (copts) {
// Prevent any more browser connections being sent to this remote, and any existing // Prevent any more browser connections being sent to this remote, and any existing
// connections from trying to send more data across the connection. // connections from trying to send more data across the connection.
remote.domains.forEach(function (domainname) { remote.domains.forEach(function (domainname) {
Devices.remove(deviceLists, domainname, remote); Devices.remove(copts.deviceLists, domainname, remote);
}); });
remote.ws = null; remote.ws = null;
remote.upgradeReq = null;
// Close all of the existing browser connections associated with this websocket connection. // Close all of the existing browser connections associated with this websocket connection.
Object.keys(remote.clients).forEach(function (cid) { Object.keys(remote.clients).forEach(function (cid) {
@ -188,7 +185,7 @@ module.exports.create = function (copts) {
} }
var firstToken; var firstToken;
var authn = (ws.upgradeReq.headers.authorization||'').split(/\s+/); var authn = (upgradeReq.headers.authorization||'').split(/\s+/);
if (authn[0] && 'basic' === authn[0].toLowerCase()) { if (authn[0] && 'basic' === authn[0].toLowerCase()) {
try { try {
authn = new Buffer(authn[1], 'base64').toString('ascii').split(':'); authn = new Buffer(authn[1], 'base64').toString('ascii').split(':');
@ -196,12 +193,12 @@ module.exports.create = function (copts) {
} catch (err) { } } catch (err) { }
} }
if (!firstToken) { if (!firstToken) {
firstToken = url.parse(ws.upgradeReq.url, true).query.access_token; firstToken = url.parse(upgradeReq.url, true).query.access_token;
} }
if (firstToken) { if (firstToken) {
var err = addToken(firstToken); var err = addToken(firstToken);
if (err) { if (err) {
ws.send(packer.pack(null, [0, err], 'control')); sendTunnelMsg(null, [0, err], 'control');
ws.close(); ws.close();
return; return;
} }
@ -231,7 +228,7 @@ module.exports.create = function (copts) {
if (!Array.isArray(cmd) || typeof cmd[0] !== 'number') { if (!Array.isArray(cmd) || typeof cmd[0] !== 'number') {
var msg = 'received bad command "' + opts.data.toString() + '"'; var msg = 'received bad command "' + opts.data.toString() + '"';
console.warn(msg, 'from websocket', socketId); console.warn(msg, 'from websocket', socketId);
ws.send(packer.pack(null, [0, {message: msg, code: 'E_BAD_COMMAND'}], 'control')); sendTunnelMsg(null, [0, {message: msg, code: 'E_BAD_COMMAND'}], 'control');
return; return;
} }
@ -260,27 +257,60 @@ module.exports.create = function (copts) {
err = { message: 'unknown command "'+cmd[1]+'"', code: 'E_UNKNOWN_COMMAND' }; err = { message: 'unknown command "'+cmd[1]+'"', code: 'E_UNKNOWN_COMMAND' };
} }
ws.send(packer.pack(null, [-cmd[0], err], 'control')); sendTunnelMsg(null, [-cmd[0], err], 'control');
} }
, onmessage: function (opts) { , onmessage: function (opts) {
var cid = packer.addrToId(opts); var cid = packer.addrToId(opts);
console.log("remote '" + logName() + "' has data for '" + cid + "'", opts.data.byteLength); console.log("remote '" + logName() + "' has data for '" + cid + "'", opts.data.byteLength);
var browserConn; var browserConn = getBrowserConn(cid);
Object.keys(remotes).some(function (jwtoken) { if (!browserConn) {
if (remotes[jwtoken].clients[cid]) { sendTunnelMsg(opts, {message: 'no matching connection', code: 'E_NO_CONN'}, 'error');
browserConn = remotes[jwtoken].clients[cid]; return;
return true;
} }
});
if (browserConn) {
browserConn.write(opts.data); browserConn.write(opts.data);
} // tunnelRead is how many bytes we've read from the tunnel, and written to the browser.
else { browserConn.tunnelRead = (browserConn.tunnelRead || 0) + opts.data.byteLength;
ws.send(packer.pack(opts, null, 'error')); // If we have more than 1MB buffered data we need to tell the other side to slow down.
// Once we've finished sending what we have we can tell the other side to keep going.
// If we've already sent the 'pause' message though don't send it again, because we're
// probably just dealing with data queued before our message got to them.
if (!browserConn.remotePaused && browserConn.bufferSize > 1024*1024) {
sendTunnelMsg(opts, browserConn.tunnelRead, 'pause');
browserConn.remotePaused = true;
browserConn.once('drain', function () {
sendTunnelMsg(opts, browserConn.tunnelRead, 'resume');
browserConn.remotePaused = false;
});
} }
} }
, onpause: function (opts) {
var cid = packer.addrToId(opts);
console.log('[TunnelPause]', cid);
var browserConn = getBrowserConn(cid);
if (browserConn) {
browserConn.manualPause = true;
browserConn.pause();
} else {
sendTunnelMsg(opts, {message: 'no matching connection', code: 'E_NO_CONN'}, 'error');
}
}
, onresume: function (opts) {
var cid = packer.addrToId(opts);
console.log('[TunnelResume]', cid);
var browserConn = getBrowserConn(cid);
if (browserConn) {
browserConn.manualPause = false;
browserConn.resume();
} else {
sendTunnelMsg(opts, {message: 'no matching connection', code: 'E_NO_CONN'}, 'error');
}
}
, onend: function (opts) { , onend: function (opts) {
var cid = packer.addrToId(opts); var cid = packer.addrToId(opts);
console.log('[TunnelEnd]', cid); console.log('[TunnelEnd]', cid);
@ -288,7 +318,7 @@ module.exports.create = function (copts) {
} }
, onerror: function (opts) { , onerror: function (opts) {
var cid = packer.addrToId(opts); var cid = packer.addrToId(opts);
console.log('[TunnelError]', cid); console.log('[TunnelError]', cid, opts.message);
closeBrowserConn(cid); closeBrowserConn(cid);
} }
}; };
@ -354,142 +384,12 @@ module.exports.create = function (copts) {
ws.on('error', hangup); ws.on('error', hangup);
// We only ever send one command and we send it once, so we just hard code the ID as 1 // We only ever send one command and we send it once, so we just hard code the ID as 1
ws.send(packer.pack(null, [1, 'hello', [unpacker._version], Object.keys(commandHandlers)], 'control')); sendTunnelMsg(null, [1, 'hello', [unpacker._version], Object.keys(commandHandlers)], 'control');
} }
function pipeWs(servername, service, browserConn, remote) { return {
console.log('[pipeWs] servername:', servername, 'service:', service); tcp: onTcpConnection
, ws: onWsConnection
var browserAddr = packer.socketToAddr(browserConn); , isClientDomain: Devices.exist.bind(null, copts.deviceLists)
browserAddr.service = service; };
var cid = packer.addrToId(browserAddr);
console.log('[pipeWs] browser is', cid, 'home-cloud is', packer.socketToId(remote.ws.upgradeReq.socket));
function sendWs(data, serviceOverride) {
if (remote.ws) {
try {
remote.ws.send(packer.pack(browserAddr, data, serviceOverride), { binary: true });
} catch (err) {
console.warn('[pipeWs] error sending websocket message', err);
}
}
}
remote.clients[cid] = browserConn;
browserConn.on('data', function (chunk) {
console.log('[pipeWs] data from browser to tunneler', chunk.byteLength);
sendWs(chunk);
});
browserConn.on('error', function (err) {
console.warn('[pipeWs] browser connection error', err);
});
browserConn.on('close', function (hadErr) {
console.log('[pipeWs] browser connection closing');
sendWs(null, hadErr ? 'error': 'end');
delete remote.clients[cid];
});
}
function onTcpConnection(browser) {
// this works when I put it here, but I don't know if it's tls yet here
// httpsServer.emit('connection', socket);
//tls3000.emit('connection', socket);
//var tlsSocket = new tls.TLSSocket(socket, { secureContext: tls.createSecureContext(tlsOpts) });
//tlsSocket.on('data', function (chunk) {
// console.log('dummy', chunk.byteLength);
//});
//return;
browser.once('data', function (firstChunk) {
// BUG XXX: this assumes that the packet won't be chunked smaller
// than the 'hello' or the point of the 'Host' header.
// This is fairly reasonable, but there are edge cases where
// it does not hold (such as manual debugging with telnet)
// and so it should be fixed at some point in the future
// defer after return (instead of being in many places)
process.nextTick(function () {
browser.unshift(firstChunk);
});
var service = 'tcp';
var servername;
var str;
var m;
function tryTls() {
if (-1 !== copts.servernames.indexOf(servername)) {
console.log("Lock and load, admin interface time!");
copts.httpsTunnel(servername, browser);
return;
}
if (!servername) {
console.log("No SNI was given, so there's nothing we can do here");
copts.httpsInvalid(servername, browser);
return;
}
var nextDevice = Devices.next(deviceLists, servername);
if (!nextDevice) {
console.log("No devices match the given servername");
copts.httpsInvalid(servername, browser);
return;
}
console.log("pipeWs(servername, service, socket, deviceLists['" + servername + "'])");
pipeWs(servername, service, browser, nextDevice);
}
// https://github.com/mscdex/httpolyglot/issues/3#issuecomment-173680155
if (22 === firstChunk[0]) {
// TLS
service = 'https';
servername = (sni(firstChunk)||'').toLowerCase();
console.log("tls hello servername:", servername);
tryTls();
return;
}
if (firstChunk[0] > 32 && firstChunk[0] < 127) {
str = firstChunk.toString();
m = str.match(/(?:^|[\r\n])Host: ([^\r\n]+)[\r\n]*/im);
servername = (m && m[1].toLowerCase() || '').split(':')[0];
console.log('servername', servername);
if (/HTTP\//i.test(str)) {
service = 'http';
// TODO disallow http entirely
// /^\/\.well-known\/acme-challenge\//.test(str)
if (/well-known/.test(str)) {
// HTTP
if (Devices.exist(deviceLists, servername)) {
pipeWs(servername, service, browser, Devices.next(deviceLists, servername));
return;
}
copts.handleHttp(servername, browser);
}
else {
// redirect to https
copts.handleInsecureHttp(servername, browser);
}
return;
}
}
console.error("Got unexpected connection", str);
browser.write(JSON.stringify({ error: {
message: "not sure what you were trying to do there..."
, code: 'E_INVALID_PROTOCOL' }
}));
browser.end();
});
browser.on('error', function (err) {
console.error('[error] tcp socket raw TODO forward and close');
console.error(err);
});
}
return { tcp: onTcpConnection, ws: onWsConnection };
}; };