passepartoutvpn
/
tunnelkit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adjust README to LZO addition 

Add Part III about LZO licensing.
This commit is contained in:
Davide De Rosa 2019-03-19 15:20:47 +01:00
parent 0b20faed27
commit 8e99c91e72
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -32,10 +32,12 @@ The client is known to work with [OpenVPN®][openvpn] 2.3+ servers.
- Disabled
- Compress (2.4)
- LZO (deprecated in 2.4)
- [x] Compression algorithms
- LZO (`--comp-lzo` only)
- [x] Key renegotiation
- [x] Replay protection (hardcoded window)
The library therefore supports compression framing, just not compression. Remember to disable server-side compression and match framing, otherwise the client will shut down with an error. E.g. if server has `comp-lzo no`, client must use `compressionFraming = .compLZO`.
The library therefore supports compression framing, just not newer compression. Remember to match server-side compression and framing, otherwise the client will shut down with an error. E.g. if server has `comp-lzo no`, client must use `compressionFraming = .compLZO`.
### Support for .ovpn configuration
@ -45,7 +47,6 @@ Unsupported:
- UDP fragmentation, i.e. `--fragment`
- Compression
- `--comp-lzo` other than `no`
- `--compress` other than empty
- Proxy
- External file references (inline `<block>` only)
@ -163,6 +164,10 @@ As seen in [libsignal-protocol-c][license-signal]:
> Additional Permissions For Submission to Apple App Store: Provided that you are otherwise in compliance with the GPLv3 for each covered work you convey (including without limitation making the Corresponding Source available in compliance with Section 6 of the GPLv3), the Author also grants you the additional permission to convey through the Apple App Store non-source executable versions of the Program as incorporated into each applicable covered work as Executable Versions only under the Mozilla Public License version 2.0 (https://www.mozilla.org/en-US/MPL/2.0/).
### Part III
Part I and II do not apply to the LZO library, which remains licensed under the terms of the GPLv2+.
### Contributing
By contributing to this project you are agreeing to the terms stated in the [Contributor License Agreement (CLA)][contrib-cla].
@ -173,6 +178,7 @@ For more details please see [CONTRIBUTING][contrib-readme].
- [PIATunnel][dep-piatunnel-repo] - Copyright (c) 2018-Present Private Internet Access
- [SwiftyBeaver][dep-swiftybeaver-repo] - Copyright (c) 2015 Sebastian Kreutzberger
- [lzo][dep-lzo-website] - Copyright (c) 1996 - 2017 Markus F.X.J. Oberhumer
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. ([https://www.openssl.org/][dep-openssl])
@ -206,6 +212,7 @@ Website: [davidederosa.com][about-website]
[dep-piatunnel-repo]: https://github.com/pia-foss/tunnel-apple
[dep-swiftybeaver-repo]: https://github.com/SwiftyBeaver/SwiftyBeaver
[dep-lzo-website]: http://www.oberhumer.com/opensource/lzo/
[about-twitter]: https://twitter.com/keeshux
[about-website]: https://davidederosa.com