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

Update README.md

Browse source 
Just a few spelling and grammar enhancements.

Former-commit-id: 1a84e1792f8d5d2ff99221d5aae75ff5d2154528
Former-commit-id: 49e1f58a3e37a1e90130c441ba1d54c099778a16 [formerly fa0fd834b306b76148d1cf401b15e6e1ba5e6f37] [formerly 0f0783a638be532e35f40073c39adb4c63c45d62 [formerly 1c18b9edc73cf4ae2d2e88e84a2a413f7771a274 [formerly 1c18b9edc73cf4ae2d2e88e84a2a413f7771a274 [formerly 1c18b9edc73cf4ae2d2e88e84a2a413f7771a274 [formerly 80d49e614dbdc1a4c71d6637938024fe37ba2e54]]]]]
Former-commit-id: efe7d29de9637769496731adf00b6dde270fc20a [formerly e8832eda0282cf2f6beda454821c9ce089548bb1]
Former-commit-id: 3468fd3c9953746fdb371e0c8cdf3625397bac62
Former-commit-id: c156b9173518bc9a86bec377e74fe0c22048b210
Former-commit-id: 02b34c411870f81028dd1dbc7970006b19a12394
Former-commit-id: a487a3662f9d52d9dfd104c219cc7a01905d48b0 [formerly 9f59d5ab9a32b3cab8753c4fd29bbedba473423c]
Former-commit-id: 64f6b3e625992ff192c9a2a5666eeef8c2e5ace1
This commit is contained in:
Jason Giedymin 2019-10-29 23:05:02 -04:00 committed by GitHub
parent 2bc2757199
commit 90393dd993
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -62,13 +62,13 @@ On your remote host, start the wstunnel's server by typing this command in your
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
On the client side use this command to forward traffic through 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.
This command will create a sock5 server listening on port 8888 of a loopback interface and will forward 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 setting in networking preferences 127.0.0.1:8888 and selecting socks5 proxy
### As proxy command for SSH
You can specify `stdio` as source port on the client side if you wish to use wstunnel as part of a proxy command for ssh
@ -84,20 +84,20 @@ 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.
The server will listen on any interface using 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)**
**Do not rely on wstunnel to protect your privacy, as it only forwards 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.
It will start a tcp server on port 9999 that will contact the corporate proxy, negotiate 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
You may now access your server from your local machine on ssh by using
```
ssh -p 9999 login@127.0.0.1
```