323a53854c
Former-commit-id: 7f062ef7536b010217a65db2ca5f4da184d346ca Former-commit-id: 11937e3d6c3e58d571a2247f6bbcd7b6de5978db [formerly d9566603235dd99f5e7d988650da080f9f08c6e0 [formerly 05fae2153e559fff6bc493ddbcbe35f56faffa5e] [formerly 05fae2153e559fff6bc493ddbcbe35f56faffa5e [formerly e17b12d004e1e6eda735d64cbfb98bffcb15a0ab]]] Former-commit-id: a38376ebcf09863582ac7c2ce019f21645834f40 Former-commit-id: 2af654b900be54ac3e4913ba2f85fea016592398 Former-commit-id: 45f3feec33f3f0e756a37f02e60d33967365c66b Former-commit-id: 95ca79d9c8eef1af5331f50dea90ad4d828d8e76 |
||
---|---|---|
app | ||
bin/wstunnel_windows_x64 | ||
src | ||
test | ||
.gitignore | ||
LICENSE | ||
README.md | ||
Setup.hs | ||
stack.yaml | ||
wstunnel.cabal |
Wstunnel
Use the websockets protocol to tunnel {TCP,UDP} traffic
wsTunnelClient <---> wsTunnelServer <---> RemoteHost
Use secure connection (wss://) to bypass proxies
wstunnel [OPTIONS] ws[s]://wstunnelServer[:port]
Client options:
-L --localToRemote=[BIND:]PORT:HOST:PORT Listen on local and forwards
traffic from remote
-D --dynamicToRemote=[BIND:]PORT Listen on local and dynamically
(with socks5 proxy) forwards
traffic from remote
-u --udp forward UDP traffic instead of
TCP
-p --httpProxy=USER:PASS@HOST:PORT If set, will use this proxy to
connect to the server
Server options:
--server Start a server that will forward
traffic for you
-r --restrictTo=HOST:PORT Accept traffic to be forwarded
only to this service
Common options:
-v --verbose Print debug information
-q --quiet Print only errors
-h --help Display help message
-V --version Print version information
Examples
Simplest one
On your remote host, start the wstunnel's server by typing this command in your terminal
wstunnel --server ws://0.0.0.0:8080
This will create a websocket server listenning on any interface on port 8080. On the client side use this command to forwards traffic trought the websocket tunnel
wstunnel -D 8888 ws://myRemoteHost:8080
This command will create a sock5 server listenning only on loopback interface on port 8888 and will forwards traffic.
Ex: With firefox you can setup a proxy using this tunnel by settings in networking preferences 127.0.0.1:8888 and selecting socks5 proxy
When behind a corporate proxy
An other useful example is when you want to bypass an http proxy (a corporate proxy for example) The most reliable way to do it is to use wstunnel as described below
Start your wstunnel server with tls activated
wstunnel --server wss://0.0.0.0:443 -r 127.0.0.1:22
The server will listen on any interface on port 443 (https) and restrict traffic to be forwarded only to the ssh daemon.
Be aware that the server will use self signed certificate with weak cryptographic algorithm. It was made in order to add the least possible overhead while still being compliant with tls.
So do not rely on wstunnel to protect your privacy, if you want to do so, forwards only traffic that is already secure by design (ex: https)
Now on the client side start the client with
wstunnel -L 9999:127.0.0.1:22 -p mycorporateproxy:8080 wss://myRemoteHost:443
It will start a tcp server on port 9999 that will contact the corporate proxy, negociate a tls connection with the remote host and forward traffic to the ssh daemon on the remote host.
You can now access your server from your local machine on ssh by using
ssh -p 9999 login@127.0.0.1
TODO
- Add sock5 proxy
- Add better logging
- Add better error handling
- Add httpProxy authentification
- Add Reverse tunnel