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

Merge pull request #30 from JasonGiedymin/JasonGiedymin-patch-1

Browse source 
Update README.md

Former-commit-id: 80e37c1b9d72973dbed0c27f17030abdfc20dfa6
Former-commit-id: 17c0e43df822687cc9882aabeb7b1624912a1dc8 [formerly af1c09329c68e048ca162dace3cd033a064c642e] [formerly 88a97173237a42504e3f889ed3e7d6cf92e79a5e [formerly 9dc06bc533cd9d1e4af180db43877b5840066fb3 [formerly 9dc06bc533cd9d1e4af180db43877b5840066fb3 [formerly 9dc06bc533cd9d1e4af180db43877b5840066fb3 [formerly 5a2ef9a555ca845e5ee3aeccf2e0f76f4889d53f]]]]]
Former-commit-id: e6cdf638cd96f08f2edb66eaace6cb0d65d6f5be [formerly d49c30cc5ade3dd74cfe1bf45dae1c0231a1cae2]
Former-commit-id: 49bbd54dd7645dfbb6d907343e15f7e5b9a9622a
Former-commit-id: 2486f567f7eea6538558172144014ad3abed9c41
Former-commit-id: 3e40cdeeff5ae2745fe879a09c05798365482b8a
Former-commit-id: f4db24873489976b4870eb8656180f696fc521eb [formerly 54a63c3ad926e023186932ea601b4525ba0dbf64]
Former-commit-id: 9bef52f5ee177a79eae3740cda6d86aa06e80e8e
This commit is contained in:
Erèbe - Romain Gerard 2019-10-30 14:41:54 +01:00 committed by GitHub
commit d22cd7f265
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
```