Update README.md

Former-commit-id: 5fccb9a64db565b72c48f1ac6a4409f6b67ae4d3
Former-commit-id: 3d578519b5d23c683e817df3f74102cc63dd1d08 [formerly 2b32e79274c23e27698b3a23e609cef87d4ed163 [formerly 63271bbdee8968cc3c74c6d3d45ffd1ec79c5066] [formerly 63271bbdee8968cc3c74c6d3d45ffd1ec79c5066 [formerly 92f072fbdd29faf411c797721911c196b77f2acf]]]
Former-commit-id: 50d1015b984061a9645fe4447f34d29215b1b18d
Former-commit-id: d33d86ea4dd65637f4998a19a83c03cd61e093cb
Former-commit-id: b8b85a65a197769a78327f5cab808918add746d7
Former-commit-id: e7b0d9482a3fc0c50b7e242bbee6839e3569784c
This commit is contained in:
Erèbe - Romain Gerard 2016-08-26 13:27:27 +02:00 committed by GitHub
parent c4079af509
commit 729940772c

View file

@ -2,9 +2,9 @@
# Wstunnel
## Description
Most of the time when you are using a public network, you are behind some kind of firewall or proxy in order to limit the traffic to only use certain type of protocols, but most of the time http is allowed.
Most of the time when you are using a public network, you are behind some kind of firewall or proxy. One of their purpose is to constrain you to only use certain kind of protocols. Nowadays, the most widespread protocol is http and is de facto allowed by third party equipement.
This tool uses the websocket protocol which is compatible with http in order to bypass firewalls and proxies and tunnel what ever traffic you want.
This tool understands this fact and uses the websocket protocol which is compatible with http in order to bypass firewalls and proxies. Wstunnel allows you to tunnel what ever traffic you want.
My inspiration went from [this project](https://www.npmjs.com/package/wstunnel) but as I don't want to have to install npm and nodejs to use this tool, I remade it in Haskell and improved it.
@ -13,8 +13,8 @@ My inspiration went from [this project](https://www.npmjs.com/package/wstunnel)
* Good error messages and debug informations
* Static tunneling (TCP and UDP)
* Dynamic tunneling (socks5 proxy)
* Support for proxy
* Support for https server (with embeded self signed certificate, see comment in the example section)
* Support for http proxy (when behind one)
* Support for tls/https server (with embeded self signed certificate, see comment in the example section)
* **Standalone binary for linux x86_64** (so just cp it where you want)
* Standalone archive for windows