derhuerst/tcp-over-websockets

Tunnel TCP through WebSockets.

tcp-over-websockets

Tunnel TCP through WebSockets. Access anything you want, even from a crappy WiFi which only allows HTTPS.

Note: chisel is probably the same thing but better. @mdslab/wstun is similar.

tunneling client

Using npx:

npx tcp-over-websockets wss://example.org github.com:22 8022

Or by installing manually:

npm install -g tcp-over-websockets
tcp-over-websockets wss://example.org github.com:22 8022

This will expose github.com:22 on localhost:8022, tunneled through a tunneling server at example.org.

Works like ssh -N -L 8022:github.com:22 [email protected], except that it's TCP over WebSockets instead of TCP over SSH.

tunneling server

Using npx:

npx -p tcp-over-websockets tcp-over-websockets-server

Or by installing manually:

npm i -g tcp-over-websockets
tcp-over-websockets-server

Contributing

If you have a question, found a bug or want to propose a feature, have a look at the issues page.

tcp-over-websockets's Issues

Syntax error launching the server

(running in Ubuntu 16.04)
tcp-over-websockets-server
/usr/local/lib/node_modules/tcp-over-websockets/server.js:44
const verifyClient = ({req}, cb) => {
^

SyntaxError: Unexpected token {
at exports.runInThisContext (vm.js:53:16)
at Module._compile (module.js:374:25)
at Object.Module._extensions..js (module.js:417:10)
at Module.load (module.js:344:32)
at Function.Module._load (module.js:301:12)
at Function.Module.runMain (module.js:442:10)
at startup (node.js:136:18)
at node.js:966:3

Typo in readme.md

At line 14 it should be tcp-over-websocket instead of tcp-over-websockets.

Support tunneling to TLS socket endpoints

Certain destination endpoints only accept connections using SSL/TLS. Examples include hosted Postgres services which enforce sslmode, like Neon.

This issue therefore proposes to:

• allow the client module to request an outbound TLS socket connection to the target destination from the server module, perhaps indicated through a URL query parameter, eg. ws://tunnel.host/target.host?protocol=tls. This will be enabled by a certain command flag like --tls-outbound
• get the server module to recognise and honor such requests

I'm willing to file the PR to impl this, and have opened the issue to solicit discussion.

README minor modification

when running the program in command line,
"tcp-over-websocket" worked for me, whereas "tcp-over-websockets" (as stated in README) did not

Source for Public Tunneling server

Is there a source for the publice server, wss://tcp-over-websockets-abvntgfmzf.now.sh in case I want to run my own?

Proxy server

Can we add support to run websockets over an http proxy server?