tunnelkit/CHANGELOG.md

467 lines
15 KiB
Markdown
Raw Normal View History

2018-10-07 08:44:59 +00:00
# Changelog
All notable changes to this project will be documented in this file.
2018-09-23 10:30:29 +00:00
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
2018-09-20 22:11:01 +00:00
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
2018-09-23 10:30:29 +00:00
2021-10-06 16:19:28 +00:00
## Unreleased
### Changed
- Avoid caching PEMs on disk (roop). [#213](https://github.com/passepartoutvpn/tunnelkit/pull/213)
2021-10-06 16:19:28 +00:00
- Upgrade OpenSSL to 1.1.1l.
## 3.4.0 (2021-08-07)
### Added
- Support for XOR patch (Sam Foxman). [#170](https://github.com/passepartoutvpn/tunnelkit/pull/170)
2021-07-18 20:53:40 +00:00
## 3.3.3 (2021-07-19)
### Added
- Support for `--compress stub-v2`.
### Fixed
- Return error in install completion handler. [#206](https://github.com/passepartoutvpn/tunnelkit/issues/206)
2021-07-17 07:26:30 +00:00
- Relax handling of whitespaces in configuration file.
2021-06-26 09:13:51 +00:00
## 3.3.2 (2021-06-26)
2021-02-12 01:44:48 +00:00
### Fixed
- Clean up cached PEMs at the end of a Session. [#203](https://github.com/passepartoutvpn/tunnelkit/pull/203)
2021-02-12 00:09:49 +00:00
## 3.3.1 (2021-02-12)
### Changed
2021-02-12 01:44:48 +00:00
- Skip keychain password prompt on macOS. [#200](https://github.com/passepartoutvpn/tunnelkit/pull/200)
2021-02-12 00:09:49 +00:00
### Fixed
2021-02-12 01:44:48 +00:00
- Restore app group in keychain queries about password references. [#201](https://github.com/passepartoutvpn/tunnelkit/pull/201)
2021-02-12 00:09:49 +00:00
2021-01-28 09:43:54 +00:00
## 3.3.0 (2021-01-28)
### Added
- Handle `--data-ciphers` and `data-ciphers-fallback` from OpenVPN 2.5
- Support DNS over HTTPS (DoH) and TLS (DoT).
### Changed
- Pick tunnel password reference from an existing keychain item context.
### Fixed
- Do not override network DNS settings when not provided by VPN. [#197](https://github.com/passepartoutvpn/tunnelkit/issues/197)
2021-01-07 21:02:49 +00:00
## 3.2.0 (2021-01-07)
2021-01-03 11:41:50 +00:00
### Changed
- Encoding of internal provider configuration.
2020-12-28 16:50:22 +00:00
## 3.1.0 (2020-12-28)
2020-12-27 22:40:20 +00:00
### Added
- Parse `--tun-mtu` option.
### Changed
- Update API to access current Wi-Fi SSID.
- Refactor access to keychain.
2020-11-15 20:13:45 +00:00
## 3.0.0 (2020-11-15)
2020-07-11 09:22:22 +00:00
### Added
- Support for Apple Silicon (macOS arm64).
2020-07-11 09:22:22 +00:00
- Customize IV_UI_VER (pahnev). [#178](https://github.com/passepartoutvpn/tunnelkit/pull/178)
### Changed
- Deployment targets raised to iOS 12.0 and macOS 10.15
- Use active profile name in VPN configuration (device settings).
### Fixed
- Incorrect tunnel bundle identifiers in Demo. [#176](https://github.com/passepartoutvpn/tunnelkit/issues/176)
2020-06-29 11:36:51 +00:00
- IV_PLAT in peer info was hardcoded to "mac" (pahnev). [#177](https://github.com/passepartoutvpn/tunnelkit/pull/177)
# 2.2.7 (2020-06-11)
### Fixed
2020-06-11 14:16:55 +00:00
- Code cleanup.
2020-05-19 22:50:55 +00:00
## 2.2.6 (2020-05-12)
### Fixed
2020-05-19 22:50:55 +00:00
- Address concerns from Guido Vranken fuzzers. [#141](https://github.com/passepartoutvpn/tunnelkit/pull/141)
2020-05-12 13:13:10 +00:00
## 2.2.5 (2020-05-12)
### Changed
- Improve IP Header parsing (roop). [#171](https://github.com/passepartoutvpn/tunnelkit/pull/171)
## 2.2.4 (2020-05-10)
### Added
- Support for SAN hostname in certificates (jaroslavas). [#168](https://github.com/passepartoutvpn/tunnelkit/pull/168)
2020-05-08 21:50:03 +00:00
### Fixed
- IPv6 traffic broken on Mojave. [#146](https://github.com/passepartoutvpn/tunnelkit/issues/146), [#169](https://github.com/passepartoutvpn/tunnelkit/pull/169)
2020-05-09 10:11:32 +00:00
- Restore tunnel MTU setting (ueshiba). [#148](https://github.com/passepartoutvpn/tunnelkit/pull/148)
- Transient connected state upon connection failure (rob-patchett). [#128](https://github.com/passepartoutvpn/tunnelkit/pull/128)
## 2.2.3 (2020-04-21)
2020-04-21 19:51:27 +00:00
### Changed
- Upgrade OpenSSL to 1.1.1g. [#166](https://github.com/passepartoutvpn/tunnelkit/issues/166)
## 2.2.2 (2020-04-20)
2020-04-18 15:11:39 +00:00
### Changed
- Upgrade OpenSSL to 1.1.1f. [#165](https://github.com/passepartoutvpn/tunnelkit/issues/165)
### Fixed
- Index out of range during negotiation (Grivus). [#143](https://github.com/passepartoutvpn/tunnelkit/pull/143)
2020-02-29 18:26:43 +00:00
- Handle server shutdown/restart (remote `--explicit-exit-notify`). [#131](https://github.com/passepartoutvpn/tunnelkit/issues/131)
2020-04-13 10:22:32 +00:00
- Abrupt disconnection upon unknown packet key id (johankool). [#161](https://github.com/passepartoutvpn/tunnelkit/pull/161)
2020-04-05 15:17:09 +00:00
- Handle explicit IPv4/IPv6 protocols (`4` or `6` suffix in `--proto`). [#153](https://github.com/passepartoutvpn/tunnelkit/issues/153)
2020-04-15 09:22:54 +00:00
- Mitigate IP traffic breaking on Mojave. [#146](https://github.com/passepartoutvpn/tunnelkit/issues/146)
2020-04-05 15:08:23 +00:00
- Pointer warnings from Xcode 11.4 upgrade.
## 2.2.1 (2019-12-14)
2019-12-12 17:37:16 +00:00
### Fixed
- Keep-alive pings coalescing over time.
- Ping timeout not checked for if keep-alive is disabled.
2019-12-11 15:44:04 +00:00
## 2.2.0 (2019-12-11)
### Changed
- Require explicit `--ca` and `--cipher` in .ovpn configuration file.
2019-11-03 01:35:56 +00:00
## 2.1.0 (2019-11-03)
2019-10-17 17:27:16 +00:00
### Added
- Allow keep-alive timeout to be configured by the server or client (Robert Patchett). [#122](https://github.com/passepartoutvpn/tunnelkit/pull/122)
2019-10-22 20:01:04 +00:00
- Support for proxy autoconfiguration URL (ThinkChaos). [#125](https://github.com/passepartoutvpn/tunnelkit/pull/125)
2019-10-25 15:53:54 +00:00
- Support multiple DNS search domains. [#127](https://github.com/passepartoutvpn/tunnelkit/issues/127)
2019-10-17 17:27:16 +00:00
2019-10-28 09:55:13 +00:00
### Changed
2019-11-03 01:35:56 +00:00
- Upgrade OpenSSL to 1.1.1d. [#123](https://github.com/passepartoutvpn/tunnelkit/issues/123)
2019-10-28 09:55:13 +00:00
2019-10-17 17:27:16 +00:00
### Fixed
- Session negotiation succeeds too early (Robert Patchett). [#124](https://github.com/passepartoutvpn/tunnelkit/pull/124)
- Handle `vpn_gateway` literal in `--route`.
2019-10-17 17:27:16 +00:00
2019-09-30 08:28:57 +00:00
## 2.0.5 (2019-09-26)
### Fixed
- OpenSSL framework structure on macOS makes binary invalid when uploaded to App Store Connect.
- Potential OOB in memcmp() (Guido Vranken).
2019-09-06 21:18:05 +00:00
## 2.0.3 (2019-09-06)
2019-08-23 07:15:37 +00:00
### Fixed
- Deadlock on shutdown (further fixes). [#106](https://github.com/passepartoutvpn/tunnelkit/issues/106)
2019-09-06 21:18:05 +00:00
- Regression with negotiation failing due to .staleSession error. [#120](https://github.com/passepartoutvpn/tunnelkit/issues/120)
2019-08-23 07:15:37 +00:00
2019-07-26 22:14:44 +00:00
## 2.0.2 (2019-07-27)
### Fixed
2019-07-11 16:45:39 +00:00
- Deadlock on shutdown. [#106](https://github.com/passepartoutvpn/tunnelkit/issues/106)
- Stuck on SOFT_RESET. [#105](https://github.com/passepartoutvpn/tunnelkit/issues/105)
- Tunnel dies unexpectedly on macOS. [#111](https://github.com/passepartoutvpn/tunnelkit/issues/111)
2019-07-26 21:25:05 +00:00
- Recover from ENOBUFS. [#112](https://github.com/passepartoutvpn/tunnelkit/issues/112)
## 2.0.1 (2019-05-28)
### Fixed
- Regression in LZO subspec.
## 2.0.0 (2019-05-28)
### Changed
- Major refactoring.
2019-05-14 09:16:56 +00:00
## 1.7.1 (2019-05-14)
### Added
2019-05-14 09:17:18 +00:00
- Partially support `--redirect-gateway block-local`. [#81](https://github.com/passepartoutvpn/tunnelkit/issues/81)
### Fixed
2019-05-14 09:17:18 +00:00
- Authentication failure due to local options. [#95](https://github.com/passepartoutvpn/tunnelkit/issues/95)
- Customize security level (to tolerate weak certificates). [#97](https://github.com/passepartoutvpn/tunnelkit/issues/97)
2019-05-14 09:16:56 +00:00
- Connection stalls on server-initiated SOFT_RESET.
- Wrong configuration mutability.
2019-05-01 09:13:27 +00:00
## 1.7.0 (2019-04-28)
2019-04-25 12:55:28 +00:00
### Changed
2019-05-14 09:17:18 +00:00
- Do not redirect all traffic to VPN unless `--redirect-gateway` specified. [#90](https://github.com/passepartoutvpn/tunnelkit/issues/90)
2019-04-27 14:13:42 +00:00
- Upgrade OpenSSL to 1.1.0j.
2019-04-25 12:55:28 +00:00
### Fixed
2019-05-14 09:17:18 +00:00
- SoftEther sends an incomplete PUSH_REPLY. [#86](https://github.com/passepartoutvpn/tunnelkit/issues/86)
- Authentication/Decrypt errors with TLS wrapping. [#88](https://github.com/passepartoutvpn/tunnelkit/issues/88), [#61](https://github.com/passepartoutvpn/tunnelkit/issues/61)
- Broken DNS when no servers provided. [#84](https://github.com/passepartoutvpn/tunnelkit/issues/84)
- UDP may disconnect on high-speed upload link. [#87](https://github.com/passepartoutvpn/tunnelkit/issues/87)
- Client certificate may fail when private key in .ovpn is encrypted. [#91](https://github.com/passepartoutvpn/tunnelkit/issues/91)
- DNS is unreachable when VPN is not default gateway. [#94](https://github.com/passepartoutvpn/tunnelkit/issues/94)
2019-04-17 07:25:36 +00:00
## 1.6.2 (2019-04-17)
### Added
2019-05-14 09:17:18 +00:00
- Basic support for proxy settings (no PAC). [#74](https://github.com/passepartoutvpn/tunnelkit/issues/74)
### Changed
- Make `hostname` optional and pick `resolvedAddresses` if nil.
### Fixed
2019-05-14 09:17:18 +00:00
- Negotiation times out with SoftEther. [#67](https://github.com/passepartoutvpn/tunnelkit/issues/67)
- Unable to handle continuated PUSH_REPLY. [#71](https://github.com/passepartoutvpn/tunnelkit/issues/71)
- TCP requiring multiple PUSH_REQUEST. [#73](https://github.com/passepartoutvpn/tunnelkit/issues/73)
- DNS inconsistencies. [#85](https://github.com/passepartoutvpn/tunnelkit/pull/85)
2019-04-08 21:28:13 +00:00
## 1.6.1 (2019-04-07)
### Fixed
- Cipher/digest erroneously required by AppExtension.
2019-04-06 14:57:56 +00:00
## 1.6.0 (2019-04-06)
### Added
2019-05-14 09:17:18 +00:00
- Handle `dhcp-option DOMAIN`. [#77](https://github.com/passepartoutvpn/tunnelkit/issues/77)
2019-04-03 10:20:34 +00:00
### Changed
2019-04-06 14:57:56 +00:00
- Refactor configuration parser for reuse.
2019-04-03 10:20:34 +00:00
### Fixed
2019-05-14 09:17:18 +00:00
- Unrecognized PKCS#8 encrypted private keys. [#80](https://github.com/passepartoutvpn/tunnelkit/issues/80)
- Handle PEM with preamble. [#78](https://github.com/passepartoutvpn/tunnelkit/issues/78)
2019-04-01 08:01:38 +00:00
## 1.5.2 (2019-04-01)
### Added
- Optional data count report via `TunnelKitProvider.Configuration.dataCount(in:)`.
2019-03-30 22:21:11 +00:00
### Changed
- Upgraded to Swift 5.
### Fixed
- `checksEKU` not propagated to TunnelKitProvider.
2019-03-25 20:20:04 +00:00
## 1.5.1 (2019-03-25)
2019-03-25 14:53:26 +00:00
### Added
2019-05-14 09:17:18 +00:00
- Scramble endpoints via `--remote-random`. [#76](https://github.com/passepartoutvpn/tunnelkit/issues/76)
- Support for encrypted certificate private keys. [#72](https://github.com/passepartoutvpn/tunnelkit/issues/72)
2019-03-25 14:53:26 +00:00
### Fixed
2019-05-14 09:17:18 +00:00
- Send explicit exit notification if UDP. [#29](https://github.com/passepartoutvpn/tunnelkit/issues/29)
- Broken reconnection on network change (mitigated). [#75](https://github.com/passepartoutvpn/tunnelkit/issues/75)
2019-03-20 15:47:09 +00:00
## 1.5.0 (2019-03-20)
2019-03-19 15:19:01 +00:00
### Added
2019-05-14 09:17:18 +00:00
- Support for legacy `--comp-lzo` compression. [#69](https://github.com/passepartoutvpn/tunnelkit/pull/69)
- Support for newer `--compress lzo` option. [#70](https://github.com/passepartoutvpn/tunnelkit/pull/70)
2019-03-19 15:19:01 +00:00
2019-03-18 17:45:56 +00:00
## 1.4.3 (2019-03-18)
2019-03-08 12:21:47 +00:00
### Fixed
- Several reconnection issues.
2019-03-18 16:27:48 +00:00
- Missing EKU flag evaluation.
2019-03-08 12:21:47 +00:00
2019-03-05 09:43:20 +00:00
## 1.4.2 (2019-03-05)
### Added
- Shut down if server pushes a compressed data packet.
2019-03-05 09:43:20 +00:00
### Fixed
- Custom DNS servers were not applied.
- Reject `<connection>` blocks as unsupported.
2019-02-25 22:46:46 +00:00
## 1.4.1 (2019-02-25)
2019-01-05 21:54:21 +00:00
### Added
2019-05-14 09:17:18 +00:00
- Override DNS servers client side. [#56](https://github.com/passepartoutvpn/tunnelkit/pull/56)
- Shut down if server pushes a compression directive. [#65](https://github.com/passepartoutvpn/tunnelkit/pull/65)
2019-01-05 21:54:21 +00:00
2019-02-23 11:07:24 +00:00
### Changed
2019-05-14 09:17:18 +00:00
- Enable or disable EKU according to `remote-cert-tls server` in .ovpn file. [#64](https://github.com/passepartoutvpn/tunnelkit/pull/64)
2019-02-23 11:07:24 +00:00
### Fixed
- Compiling errors in demo target.
- Linking errors with OpenSSL.
2019-02-25 22:35:38 +00:00
- A few potential vulnerabilities.
2018-11-17 17:01:14 +00:00
## 1.4.0 (2018-11-12)
2018-11-10 10:15:24 +00:00
### Added
2019-05-14 09:17:18 +00:00
- Parser for .ovpn configuration files. [#47](https://github.com/passepartoutvpn/tunnelkit/pull/47)
2018-11-10 10:15:24 +00:00
### Changed
2019-05-14 09:17:18 +00:00
- Due to [#47](https://github.com/passepartoutvpn/tunnelkit/pull/47), `SocketType` and `EndpointProtocol` were moved to Core subspec.
2018-11-10 10:15:24 +00:00
2018-11-07 23:00:06 +00:00
## 1.3.1 (2018-11-07)
2018-11-05 19:26:39 +00:00
### Fixed
2019-05-14 09:17:18 +00:00
- IPv4/UInt32 conversions are not endianness-agnostic. [#46](https://github.com/passepartoutvpn/tunnelkit/pull/46)
2018-11-05 19:26:39 +00:00
2018-10-27 22:32:01 +00:00
## 1.3.0 (2018-10-28)
2018-10-25 20:39:48 +00:00
### Changed
2019-05-14 09:17:18 +00:00
- Refactored tunnel configuration API for increased code reuse. [#44](https://github.com/passepartoutvpn/tunnelkit/pull/44)
2018-10-25 20:39:48 +00:00
### Deprecated
2019-05-14 09:17:18 +00:00
- Use high-level accessories instead of `debugLogKey` and `lastErrorKey`. [#45](https://github.com/passepartoutvpn/tunnelkit/pull/45)
2018-10-25 20:39:48 +00:00
2018-10-26 16:55:34 +00:00
### Fixed
- IPv4/UInt32 calculations were wrong.
2018-10-25 05:30:53 +00:00
## 1.2.2 (2018-10-25)
2018-10-21 22:46:08 +00:00
2018-10-24 17:53:38 +00:00
### Changed
2018-10-21 22:46:08 +00:00
2019-05-14 09:17:18 +00:00
- Debug log is saved to group container rather than `UserDefaults`. [#43](https://github.com/passepartoutvpn/tunnelkit/pull/43)
2018-10-21 22:46:08 +00:00
2018-10-24 17:53:38 +00:00
### Fixed
2018-10-24 16:56:11 +00:00
2019-05-14 09:17:18 +00:00
- Handle server-initiated renegotiation. [#41](https://github.com/passepartoutvpn/tunnelkit/pull/41)
- Potentially private data (e.g. Internet addresses) is now masked in debug log. [#42](https://github.com/passepartoutvpn/tunnelkit/pull/42)
2018-10-24 16:56:11 +00:00
2018-10-24 17:53:38 +00:00
## 1.2.1 (2018-10-24)
### Added
2019-05-14 09:17:18 +00:00
- Configuration key `lastErrorKey` for reporting errors to host app. [#40](https://github.com/passepartoutvpn/tunnelkit/pull/40)
- Server extended key usage validation (EKU). [#27](https://github.com/passepartoutvpn/tunnelkit/issues/27)
2018-10-24 17:53:38 +00:00
2018-10-21 22:46:08 +00:00
### Fixed
- CA file was not closed after MD5 calculation when using PIA patches.
2019-05-14 09:17:18 +00:00
- Mitigated an issue with MTU in TCP mode during negotiation. [#39](https://github.com/passepartoutvpn/tunnelkit/issues/39)
2018-10-21 22:46:08 +00:00
2018-10-20 09:15:36 +00:00
## 1.2.0 (2018-10-20)
2018-10-19 13:56:15 +00:00
2018-10-19 15:39:37 +00:00
### Added
2018-10-19 13:56:15 +00:00
2019-05-14 09:17:18 +00:00
- Support for `--tls-auth` wrapping. [#34](https://github.com/passepartoutvpn/tunnelkit/pull/34)
- Support for `--tls-crypt` wrapping. [#35](https://github.com/passepartoutvpn/tunnelkit/pull/35)
- Parser for static OpenVPN keys from file. [#36](https://github.com/passepartoutvpn/tunnelkit/pull/36)
2018-10-19 15:39:37 +00:00
### Fixed
2019-05-14 09:17:18 +00:00
- Handling of mixed DATA_V1/DATA_V2 packets. [#30](https://github.com/passepartoutvpn/tunnelkit/issues/30)
2018-10-19 13:56:15 +00:00
2018-10-18 14:35:20 +00:00
## 1.1.2 (2018-10-18)
2018-10-18 14:25:42 +00:00
### Added
2019-05-14 09:17:18 +00:00
- Restored support for PIA patches. [#32](https://github.com/passepartoutvpn/tunnelkit/pull/32)
2018-10-18 14:25:42 +00:00
2018-10-10 20:23:20 +00:00
## 1.1.1 (2018-10-10)
### Fixed
2019-05-14 09:17:18 +00:00
- Make CA non-optional. [#28](https://github.com/passepartoutvpn/tunnelkit/pull/28)
2018-10-10 20:23:20 +00:00
2018-09-23 13:15:06 +00:00
## 1.1.0 (2018-09-26)
2018-09-23 10:30:29 +00:00
### Added
2019-05-14 09:17:18 +00:00
- Client certificate verification. [#3](https://github.com/passepartoutvpn/tunnelkit/pull/3)
- Support for both `--comp-lzo` and `--compress` compression framing. [#2](https://github.com/passepartoutvpn/tunnelkit/pull/2), [#5](https://github.com/passepartoutvpn/tunnelkit/pull/5), [#10](https://github.com/passepartoutvpn/tunnelkit/pull/10)
- Routes setup from PUSH_REPLY. [#7](https://github.com/passepartoutvpn/tunnelkit/pull/7)
- Support for IPv6. [#8](https://github.com/passepartoutvpn/tunnelkit/pull/8)
- Support for server-side NCP. [#11](https://github.com/passepartoutvpn/tunnelkit/pull/11)
- Property to mark ciphers not requiring digest auth (e.g. GCM). [#13](https://github.com/passepartoutvpn/tunnelkit/pull/13)
- `Codable` implementations for native Swift serialization. [#15](https://github.com/passepartoutvpn/tunnelkit/pull/15)
- More cipher and digest algorithms. [#16](https://github.com/passepartoutvpn/tunnelkit/pull/16)
- Negotiated compression framing from PUSH_REPLY. [#19](https://github.com/passepartoutvpn/tunnelkit/pull/19)
- Customizable keep-alive. [#20](https://github.com/passepartoutvpn/tunnelkit/pull/20)
- Negotiated keep-alive from PUSH_REPLY. [#22](https://github.com/passepartoutvpn/tunnelkit/pull/22)
2018-09-23 10:30:29 +00:00
- Peer-info metadata.
### Changed
- Raised iOS target to 11 (drops 32-bit support).
- Upgraded OpenSSL from 1.1.0h to 1.1.0i.
- Minor adjustments for Xcode 10 / Swift 4.2.
2018-09-23 10:30:29 +00:00
- Deep refactoring of control channel for future extensibility.
- App group moved out of tunnel configuration, to make it more platform-agnostic and coherent to serialize.
- Keep-alive is disabled by default.
2018-09-23 10:30:29 +00:00
- Several internal renamings.
### Fixed
2019-05-14 09:17:18 +00:00
- Sensitive data logged in PUSH_REPLY. [#12](https://github.com/passepartoutvpn/tunnelkit/pull/12)
- Bad interpretation of 0 seconds between renegotiations. [#18](https://github.com/passepartoutvpn/tunnelkit/pull/18)
- Incorrect behavior on data-related failures. [#21](https://github.com/passepartoutvpn/tunnelkit/pull/21)
2018-09-23 10:30:29 +00:00
## 1.0.0 (2018-08-23)
### Added
- Initial fork from https://github.com/pia-foss/tunnel-apple
### Removed
- Non-standard PIA patches.