hex/wstunnel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Erèbe - Romain Gerard 2016-08-25 13:51:48 +02:00 committed by GitHub
parent 1fea3eadda
commit 8d839466bc
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -27,7 +27,8 @@ Common options:
-V --version Print version information -V --version Print version information
``` ```
## Example ## Examples
### Simplest one
On your remote host, start the wstunnel's server by typing this command in your terminal On your remote host, start the wstunnel's server by typing this command in your terminal
``` ```
wstunnel --server ws://0.0.0.0:8080 wstunnel --server ws://0.0.0.0:8080
@ -37,9 +38,11 @@ On the client side use this command to forwards traffic trought the websocket tu
``` ```
wstunnel -D 8888 ws://myRemoteHost:8080 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 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 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) 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 The most reliable way to do it is to use wstunnel as described below
@ -48,9 +51,11 @@ Start your wstunnel server with tls activated
wstunnel --server wss://0.0.0.0:443 -r 127.0.0.1:22 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. 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. **Be aware that the server will use self signed certificate with weak cryptographic algorithm.
It was made in order add the least possible overhead while still being compliant with tls. 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 forwards only traffic that is already secure by design (ex: https)**
**So do not rely on wstunnel to protect your privacy, if you want to do forwards only traffic that is already secure by design (ex: https)**
Now on the client side start the client with Now on the client side start the client with
``` ```