From 34b3bcb50906a769eb8d7ce5454e311b8bd8c21d Mon Sep 17 00:00:00 2001 From: Davide De Rosa Date: Thu, 30 Aug 2018 11:11:37 +0200 Subject: [PATCH] Update README about compression framing --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dee51ab..de2eb6e 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,13 @@ The client is known to work with [OpenVPN®][openvpn] 2.3+ servers. Key renegoti - [x] TLS handshake - CA validation - Client certificate -- [x] Key renegotiation (client-initiated) +- [x] Compression framing + - Disabled + - Compress (2.4) + - LZO (deprecated in 2.4) - [x] Replay protection (hardcoded window) -The library does not currently support compression, so you must disable it server-side in order to avoid a confusing loss of data packets. The `TunnelKitProvider.Configuration.LZOFraming` option is deprecated and only provided for interoperability with `comp-lzo no`. +The library therefore supports compression framing, just not compression. Remember to match server-side compression framing in order to avoid a confusing loss of data packets. E.g. if server has `comp-lzo no`, client must use `compressionFraming = .compLZO`. ## Installation