Mention XOR option in README

This commit is contained in:
Davide De Rosa 2021-07-23 11:14:20 +02:00
parent 65774c9a09
commit 434817c563
1 changed files with 11 additions and 3 deletions

View File

@ -39,9 +39,16 @@ The library therefore supports compression framing, just not newer compression.
### Support for .ovpn configuration ### Support for .ovpn configuration
TunnelKit can parse .ovpn configuration files. Below are a few limitations worth mentioning. TunnelKit can parse .ovpn configuration files. Below are a few details worth mentioning.
Unsupported: #### Non-standard
- Single-byte XOR masking
- Via `--scramble xormask <character>`
- XOR all incoming and outgoing bytes by the ASCII value of the character argument
- See [Tunnelblick website][about-tunnelblick-xor] for more details
#### Unsupported
- UDP fragmentation, i.e. `--fragment` - UDP fragmentation, i.e. `--fragment`
- Compression via `--compress` other than empty or `lzo` - Compression via `--compress` other than empty or `lzo`
@ -51,7 +58,7 @@ Unsupported:
- `<connection>` blocks - `<connection>` blocks
- `vpn_gateway` and `net_gateway` literals in routes - `vpn_gateway` and `net_gateway` literals in routes
Ignored: #### Ignored
- Some MTU overrides - Some MTU overrides
- `--link-mtu` and variants - `--link-mtu` and variants
@ -240,6 +247,7 @@ Website: [passepartoutvpn.app][about-website]
[ppl-surfnet]: https://www.surf.nl/en/about-surf/subsidiaries/surfnet [ppl-surfnet]: https://www.surf.nl/en/about-surf/subsidiaries/surfnet
[ppl-xmb5]: https://github.com/XMB5 [ppl-xmb5]: https://github.com/XMB5
[ppl-xmb5-xor]: https://github.com/passepartoutvpn/tunnelkit/pull/170 [ppl-xmb5-xor]: https://github.com/passepartoutvpn/tunnelkit/pull/170
[about-tunnelblick-xor]: https://tunnelblick.net/cOpenvpn_xorpatch.html
[about-twitter]: https://twitter.com/keeshux [about-twitter]: https://twitter.com/keeshux
[about-website]: https://passepartoutvpn.app [about-website]: https://passepartoutvpn.app