update readme

This commit is contained in:
Σrebe - Romain GERARD 2023-11-26 18:25:35 +01:00
parent f48b156542
commit 809a6d0e89
No known key found for this signature in database
GPG key ID: 7A42B4B97E0332F4

View file

@ -66,6 +66,11 @@ Options:
'udp://1212:1.1.1.1:53?timeout_sec=10' timeout_sec on udp force close the tunnel after 10sec. Set it to 0 to disable the timeout [default: 30] 'udp://1212:1.1.1.1:53?timeout_sec=10' timeout_sec on udp force close the tunnel after 10sec. Set it to 0 to disable the timeout [default: 30]
'socks5://[::1]:1212' => listen locally with socks5 on port 1212 and forward dynamically requested tunnel 'socks5://[::1]:1212' => listen locally with socks5 on port 1212 and forward dynamically requested tunnel
'stdio://google.com:443' => listen for data from stdio, mainly for `ssh -o ProxyCommand="wstunnel client -L stdio://%h:%p ws://localhost:8080" my-server` 'stdio://google.com:443' => listen for data from stdio, mainly for `ssh -o ProxyCommand="wstunnel client -L stdio://%h:%p ws://localhost:8080" my-server`
-R, --remote-to-local <{tcp,udp}://[BIND:]PORT:HOST:PORT>
Listen on remote and forwards traffic from local. Can be specified multiple times. Only tcp is supported
examples:
'tcp://1212:google.com:443' => listen on server for incoming tcp cnx on port 1212 and forward to google.com on port 443 from local machine
'udp://1212:1.1.1.1:53' => listen on server for incoming udp on port 1212 and forward to cloudflare dns 1.1.1.1 on port 53 from local machine
--socket-so-mark <INT> --socket-so-mark <INT>
(linux only) Mark network packet with SO_MARK sockoption with the specified value. (linux only) Mark network packet with SO_MARK sockoption with the specified value.
You need to use {root, sudo, capabilities} to run wstunnel when using this option You need to use {root, sudo, capabilities} to run wstunnel when using this option
@ -234,11 +239,3 @@ and run those commands at the root of the project
cargo build cargo build
target/debug/wstunnel ... target/debug/wstunnel ...
``` ```
## TODO
- [x] Add socks5 proxy
- [x] Add better logging
- [x] Add better error handling
- [x] Add httpProxy authentification
- [ ] Add Reverse tunnel
- [x] Add more tests for socks5 proxy