diff --git a/README.md b/README.md index 1c2dbcce92bfd28775f613a3a38afe5ee244fc31..4a3bb9ad34d46204eae5450657f19ebee92fa54e 100644 --- a/README.md +++ b/README.md @@ -31,12 +31,12 @@ tactics to the LEAP VPN Clients, and in particular about the design of the - Application data is written to the specified interface (typically a `tun` device started by `OpenVPN`). - `OpenVPN` provides end-to-end encryption and a reliability layer. We'll be - testing with the `2.5.x` branch of the reference OpenVPN implementation. + testing with the `2.6.x` branch of the reference OpenVPN implementation. - `obfs4` is used for an extra layer of encryption and obfuscation. It is a look-like-nothing protocol that also hides the key exchange to the eyes of the censor. - `obfs4` requires a stream protocol to write to/read from. The default is TCP, - but KCP is a configurable optional. `QUIC` could be an avenue of further exploration. + but KCP and `QUIC` are configurable UDP based options. ## Development and Testing @@ -329,7 +329,7 @@ To get information about obfs4 server bridges to connect to, you can query the m ] ``` -So, supposing that you wanted to connect to the `cod.demo.bitmask.net` obfsvpn server over "normal"/non-KCP, you could run: +So, supposing that you wanted to connect to the `cod.demo.bitmask.net` obfsvpn server over obfs4, you could run: ``` $ go run ./cmd/client -c "k0L4LFg0Wk98v7P66xvgAx2ud+kggvjZX/qul3iFTJGH5X7xSHT+vVL4UZR0WI3SkmDzUg" -r 37.218.245.94 -rp 443 -v 2024/08/12 16:16:42 proxyAddr: 127.0.0.1:8080 @@ -348,7 +348,7 @@ UNCONN 0 0 You can specify a particular listening address with the `-i` flag and a particular listening port with the `-p` flag. -If you want to connect via KCP, use the port for the host that's listening w/ KCP and specify the `-kcp` flag: +If you want to connect via obfs4+KCP, use the port for the host that's listening w/ KCP and specify the `-kcp` flag: ``` $ go run ./cmd/client -c "k0L4LFg0Wk98v7P66xvgAx2ud+kggvjZX/qul3iFTJGH5X7xSHT+vVL4UZR0WI3SkmDzUg" -r 37.218.245.94 -rp 4431 -v -kcp @@ -359,8 +359,13 @@ $ go run ./cmd/client -c "k0L4LFg0Wk98v7P66xvgAx2ud+kggvjZX/qul3iFTJGH5X7xSHT+vV 2024/08/12 16:22:11 Update state: RUNNING ``` +If you want to connect via QUIC instead of obfs4+KCP, replace the `-kcp` flag with `-quic` and choose the port the host is listening for quic connections, for example: +``` +$ go run ./cmd/client -c "k0L4LFg0Wk98v7P66xvgAx2ud+kggvjZX/qul3iFTJGH5X7xSHT+vVL4UZR0WI3SkmDzUg" -r 37.218.245.94 -rp 4432 -v -quic +``` + -If you wanted to run openvpn through that particular bridge, you'd specify the `--remote` and `--proto udp` flags when running the openvpn command: +In order to run openvpn through that particular bridge, specify the `--remote` and `--proto udp` flags when running the openvpn command: ``` $ openvpn --remote 127.0.0.1 8080 --proto udp [A BUNCH MORE OPENVPN FLAGS/CONFIGS HERE] ```