tunnelkit/TunnelKit/Sources/AppExtension/TunnelKitProvider.swift

652 lines
23 KiB
Swift
Raw Normal View History

2018-08-23 08:19:25 +00:00
//
// TunnelKitProvider.swift
// TunnelKit
2018-08-23 08:19:25 +00:00
//
// Created by Davide De Rosa on 2/1/17.
2019-03-09 10:44:18 +00:00
// Copyright (c) 2019 Davide De Rosa. All rights reserved.
//
// https://github.com/keeshux
//
// This file is part of TunnelKit.
//
// TunnelKit is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// TunnelKit is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with TunnelKit. If not, see <http://www.gnu.org/licenses/>.
//
// This file incorporates work covered by the following copyright and
// permission notice:
//
// Copyright (c) 2018-Present Private Internet Access
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
2018-08-23 08:19:25 +00:00
//
import NetworkExtension
import SwiftyBeaver
private let log = SwiftyBeaver.self
/**
Provides an all-in-one `NEPacketTunnelProvider` implementation for use in a
Packet Tunnel Provider extension both on iOS and macOS.
*/
open class TunnelKitProvider: NEPacketTunnelProvider {
2018-08-23 08:19:25 +00:00
// MARK: Tweaks
/// An optional string describing host app version on tunnel start.
public var appVersion: String?
/// The log separator between sessions.
public var logSeparator = "--- EOF ---"
/// The maximum number of lines in the log.
public var maxLogLines = 1000
/// The number of milliseconds after which a DNS resolution fails.
public var dnsTimeout = 3000
/// The number of milliseconds after which the tunnel gives up on a connection attempt.
public var socketTimeout = 5000
/// The number of milliseconds after which the tunnel is shut down forcibly.
public var shutdownTimeout = 2000
/// The number of milliseconds after which a reconnection attempt is issued.
public var reconnectionDelay = 1000
/// The number of link failures after which the tunnel is expected to die.
public var maxLinkFailures = 3
/// The number of milliseconds between data count updates. Set to 0 to disable updates (default).
public var dataCountInterval = 0
2018-08-23 08:19:25 +00:00
// MARK: Constants
private let memoryLog = MemoryDestination()
private let observer = InterfaceObserver()
private let tunnelQueue = DispatchQueue(label: TunnelKitProvider.description())
2018-08-23 08:19:25 +00:00
private let prngSeedLength = 64
private var cachesURL: URL {
guard let appGroup = appGroup else {
fatalError("Accessing cachesURL before parsing app group")
}
guard let containerURL = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: appGroup) else {
fatalError("No access to app group: \(appGroup)")
}
return containerURL.appendingPathComponent("Library/Caches/")
2018-08-23 08:19:25 +00:00
}
2018-08-23 08:19:25 +00:00
// MARK: Tunnel configuration
private var appGroup: String!
private lazy var defaults = UserDefaults(suiteName: appGroup)
2018-08-23 08:19:25 +00:00
private var cfg: Configuration!
private var strategy: ConnectionStrategy!
// MARK: Internal state
private var proxy: SessionProxy?
private var socket: GenericSocket?
private var pendingStartHandler: ((Error?) -> Void)?
private var pendingStopHandler: (() -> Void)?
private var isCountingData = false
2018-08-23 08:19:25 +00:00
// MARK: NEPacketTunnelProvider (XPC queue)
/// :nodoc:
open override func startTunnel(options: [String : NSObject]? = nil, completionHandler: @escaping (Error?) -> Void) {
// required configuration
let hostname: String
2018-08-23 08:19:25 +00:00
do {
guard let tunnelProtocol = protocolConfiguration as? NETunnelProviderProtocol else {
2018-10-21 10:58:36 +00:00
throw ProviderConfigurationError.parameter(name: "protocolConfiguration")
2018-08-23 08:19:25 +00:00
}
guard let serverAddress = tunnelProtocol.serverAddress else {
2018-10-21 10:58:36 +00:00
throw ProviderConfigurationError.parameter(name: "protocolConfiguration.serverAddress")
}
2018-08-23 08:19:25 +00:00
guard let providerConfiguration = tunnelProtocol.providerConfiguration else {
2018-10-21 10:58:36 +00:00
throw ProviderConfigurationError.parameter(name: "protocolConfiguration.providerConfiguration")
2018-08-23 08:19:25 +00:00
}
hostname = serverAddress
try appGroup = Configuration.appGroup(from: providerConfiguration)
2018-08-23 08:19:25 +00:00
try cfg = Configuration.parsed(from: providerConfiguration)
} catch let e {
var message: String?
2018-10-21 10:58:36 +00:00
if let te = e as? ProviderConfigurationError {
2018-08-23 08:19:25 +00:00
switch te {
2018-10-21 10:58:36 +00:00
case .parameter(let name):
message = "Tunnel configuration incomplete: \(name)"
2018-08-23 08:19:25 +00:00
default:
break
}
}
NSLog(message ?? "Unexpected error in tunnel configuration: \(e)")
completionHandler(e)
return
}
// optional credentials
let credentials: SessionProxy.Credentials?
if let username = protocolConfiguration.username, let passwordReference = protocolConfiguration.passwordReference,
let password = try? Keychain.password(for: username, reference: passwordReference) {
credentials = SessionProxy.Credentials(username, password)
} else {
credentials = nil
}
strategy = ConnectionStrategy(hostname: hostname, configuration: cfg)
2018-08-23 08:19:25 +00:00
if let content = cfg.existingLog(in: appGroup) {
var existingLog = content.components(separatedBy: "\n")
2018-08-23 08:19:25 +00:00
if let i = existingLog.index(of: logSeparator) {
existingLog.removeFirst(i + 2)
}
existingLog.append("")
existingLog.append(logSeparator)
existingLog.append("")
memoryLog.start(with: existingLog)
}
configureLogging(
debug: cfg.shouldDebug,
customFormat: cfg.debugLogFormat
)
// override library configuration
if let masksPrivateData = cfg.masksPrivateData {
CoreConfiguration.masksPrivateData = masksPrivateData
}
2018-08-23 08:19:25 +00:00
log.info("Starting tunnel...")
cfg.clearLastError(in: appGroup)
2018-08-23 08:19:25 +00:00
guard SessionProxy.EncryptionBridge.prepareRandomNumberGenerator(seedLength: prngSeedLength) else {
2018-10-21 10:58:36 +00:00
completionHandler(ProviderConfigurationError.prngInitialization)
2018-08-23 08:19:25 +00:00
return
}
cfg.print(appVersion: appVersion)
let proxy: SessionProxy
do {
proxy = try SessionProxy(queue: tunnelQueue, configuration: cfg.sessionConfiguration, cachesURL: cachesURL)
refreshDataCount()
2018-08-23 08:19:25 +00:00
} catch let e {
completionHandler(e)
return
}
proxy.credentials = credentials
2018-08-23 08:19:25 +00:00
proxy.delegate = self
self.proxy = proxy
logCurrentSSID()
pendingStartHandler = completionHandler
tunnelQueue.sync {
self.connectTunnel()
}
}
/// :nodoc:
open override func stopTunnel(with reason: NEProviderStopReason, completionHandler: @escaping () -> Void) {
pendingStartHandler = nil
log.info("Stopping tunnel...")
cfg.clearLastError(in: appGroup)
2018-08-23 08:19:25 +00:00
guard let proxy = proxy else {
flushLog()
completionHandler()
return
}
pendingStopHandler = completionHandler
tunnelQueue.schedule(after: .milliseconds(shutdownTimeout)) {
guard let pendingHandler = self.pendingStopHandler else {
return
}
log.warning("Tunnel not responding after \(self.shutdownTimeout) milliseconds, forcing stop")
self.flushLog()
pendingHandler()
}
tunnelQueue.sync {
proxy.shutdown(error: nil)
}
}
/// :nodoc:
open override func handleAppMessage(_ messageData: Data, completionHandler: ((Data?) -> Void)? = nil) {
var response: Data?
switch Message(messageData) {
case .requestLog:
response = memoryLog.description.data(using: .utf8)
case .dataCount:
if let proxy = proxy, let dataCount = proxy.dataCount() {
2018-08-23 08:19:25 +00:00
response = Data()
response?.append(UInt64(dataCount.0)) // inbound
response?.append(UInt64(dataCount.1)) // outbound
2018-08-23 08:19:25 +00:00
}
default:
break
}
completionHandler?(response)
}
// MARK: Connection (tunnel queue)
private func connectTunnel(upgradedSocket: GenericSocket? = nil, preferredAddress: String? = nil) {
log.info("Creating link session")
// reuse upgraded socket
if let upgradedSocket = upgradedSocket, !upgradedSocket.isShutdown {
log.debug("Socket follows a path upgrade")
connectTunnel(via: upgradedSocket)
return
}
strategy.createSocket(from: self, timeout: dnsTimeout, preferredAddress: preferredAddress, queue: tunnelQueue) { (socket, error) in
guard let socket = socket else {
self.disposeTunnel(error: error)
return
}
self.connectTunnel(via: socket)
}
}
private func connectTunnel(via socket: GenericSocket) {
log.info("Will connect to \(socket)")
cfg.clearLastError(in: appGroup)
2018-08-23 08:19:25 +00:00
log.debug("Socket type is \(type(of: socket))")
self.socket = socket
self.socket?.delegate = self
self.socket?.observe(queue: tunnelQueue, activeTimeout: socketTimeout)
}
private func finishTunnelDisconnection(error: Error?) {
if let proxy = proxy, !(reasserting && proxy.canRebindLink()) {
proxy.cleanup()
}
socket?.delegate = nil
socket?.unobserve()
socket = nil
if let error = error {
log.error("Tunnel did stop (error: \(error))")
setErrorStatus(with: error)
2018-08-23 08:19:25 +00:00
} else {
log.info("Tunnel did stop on request")
}
}
private func disposeTunnel(error: Error?) {
flushLog()
2018-08-23 08:19:25 +00:00
// failed to start
if (pendingStartHandler != nil) {
//
// CAUTION
//
// passing nil to this callback will result in an extremely undesired situation,
// because NetworkExtension would interpret it as "successfully connected to VPN"
//
// if we end up here disposing the tunnel with a pending start handled, we are
// 100% sure that something wrong happened while starting the tunnel. in such
// case, here we then must also make sure that an error object is ALWAYS
// provided, so we do this with optional fallback to .socketActivity
//
// socketActivity makes sense, given that any other error would normally come
// from SessionProxy.stopError. other paths to disposeTunnel() are only coming
// from stopTunnel(), in which case we don't need to feed an error parameter to
// the stop completion handler
//
pendingStartHandler?(error ?? ProviderError.socketActivity)
pendingStartHandler = nil
}
// stopped intentionally
else if (pendingStopHandler != nil) {
pendingStopHandler?()
pendingStopHandler = nil
}
// stopped externally, unrecoverable
else {
cancelTunnelWithError(error)
}
}
// MARK: Data counter (tunnel queue)
private func refreshDataCount() {
guard dataCountInterval > 0 else {
return
}
tunnelQueue.schedule(after: .milliseconds(dataCountInterval)) { [weak self] in
self?.refreshDataCount()
}
guard isCountingData, let proxy = proxy, let dataCount = proxy.dataCount() else {
defaults?.removeDataCountArray()
return
}
defaults?.dataCountArray = [dataCount.0, dataCount.1]
}
2018-08-23 08:19:25 +00:00
}
extension TunnelKitProvider: GenericSocketDelegate {
2018-08-23 08:19:25 +00:00
// MARK: GenericSocketDelegate (tunnel queue)
func socketDidTimeout(_ socket: GenericSocket) {
log.debug("Socket timed out waiting for activity, cancelling...")
reasserting = true
socket.shutdown()
// fallback: TCP connection timeout suggests falling back
if let _ = socket as? NETCPSocket {
guard tryNextProtocol() else {
// disposeTunnel
return
}
2018-08-23 08:19:25 +00:00
}
}
func socketDidBecomeActive(_ socket: GenericSocket) {
guard let proxy = proxy else {
return
}
if proxy.canRebindLink() {
proxy.rebindLink(socket.link(withMTU: cfg.mtu))
2018-08-23 08:19:25 +00:00
reasserting = false
} else {
proxy.setLink(socket.link(withMTU: cfg.mtu))
2018-08-23 08:19:25 +00:00
}
}
func socket(_ socket: GenericSocket, didShutdownWithFailure failure: Bool) {
guard let proxy = proxy else {
return
}
var shutdownError: Error?
let didTimeoutNegotiation: Bool
var upgradedSocket: GenericSocket?
// look for error causing shutdown
shutdownError = proxy.stopError
if failure && (shutdownError == nil) {
shutdownError = ProviderError.linkError
2018-08-23 08:19:25 +00:00
}
didTimeoutNegotiation = (shutdownError as? SessionError == .negotiationTimeout)
2018-09-07 20:43:52 +00:00
// only try upgrade on network errors
if shutdownError as? SessionError == nil {
upgradedSocket = socket.upgraded()
}
2018-09-07 20:43:52 +00:00
// clean up
finishTunnelDisconnection(error: shutdownError)
// fallback: UDP is connection-less, treat negotiation timeout as socket timeout
2018-09-07 20:43:52 +00:00
if didTimeoutNegotiation {
guard tryNextProtocol() else {
2018-09-07 20:43:52 +00:00
// disposeTunnel
return
}
2018-08-23 08:19:25 +00:00
}
2018-09-07 20:43:52 +00:00
// reconnect?
2018-08-23 08:19:25 +00:00
if reasserting {
log.debug("Disconnection is recoverable, tunnel will reconnect in \(reconnectionDelay) milliseconds...")
tunnelQueue.schedule(after: .milliseconds(reconnectionDelay)) {
// give up if reasserting cleared in the meantime
guard self.reasserting else {
return
}
2018-08-23 08:19:25 +00:00
self.connectTunnel(upgradedSocket: upgradedSocket, preferredAddress: socket.remoteAddress)
}
return
}
2018-09-07 20:43:52 +00:00
// shut down
2018-08-23 08:19:25 +00:00
disposeTunnel(error: shutdownError)
}
func socketHasBetterPath(_ socket: GenericSocket) {
log.debug("Stopping tunnel due to a new better path")
logCurrentSSID()
proxy?.reconnect(error: ProviderError.networkChanged)
}
}
extension TunnelKitProvider: SessionProxyDelegate {
2018-08-23 08:19:25 +00:00
// MARK: SessionProxyDelegate (tunnel queue)
/// :nodoc:
public func sessionDidStart(_ proxy: SessionProxy, remoteAddress: String, reply: SessionReply) {
2018-08-23 08:19:25 +00:00
reasserting = false
log.info("Session did start")
log.info("Returned ifconfig parameters:")
2018-10-24 16:06:39 +00:00
log.info("\tRemote: \(remoteAddress.maskedDescription)")
log.info("\tIPv4: \(reply.ipv4?.description ?? "not configured")")
log.info("\tIPv6: \(reply.ipv6?.description ?? "not configured")")
2018-10-24 16:06:39 +00:00
log.info("\tDNS: \(reply.dnsServers.map { $0.maskedDescription })")
2018-08-23 08:19:25 +00:00
bringNetworkUp(remoteAddress: remoteAddress, reply: reply) { (error) in
2018-08-23 08:19:25 +00:00
if let error = error {
log.error("Failed to configure tunnel: \(error)")
self.pendingStartHandler?(error)
self.pendingStartHandler = nil
return
}
log.info("Tunnel interface is now UP")
proxy.setTunnel(tunnel: NETunnelInterface(impl: self.packetFlow, isIPv6: reply.ipv6 != nil))
2018-08-23 08:19:25 +00:00
self.pendingStartHandler?(nil)
self.pendingStartHandler = nil
}
isCountingData = true
2018-08-23 08:19:25 +00:00
}
/// :nodoc:
public func sessionDidStop(_: SessionProxy, shouldReconnect: Bool) {
log.info("Session did stop")
isCountingData = false
refreshDataCount()
reasserting = shouldReconnect
2018-08-23 08:19:25 +00:00
socket?.shutdown()
}
private func bringNetworkUp(remoteAddress: String, reply: SessionReply, completionHandler: @escaping (Error?) -> Void) {
2018-08-23 08:19:25 +00:00
// route all traffic to VPN
var ipv4Settings: NEIPv4Settings?
if let ipv4 = reply.ipv4 {
let defaultRoute = NEIPv4Route.default()
defaultRoute.gatewayAddress = ipv4.defaultGateway
var routes: [NEIPv4Route] = [defaultRoute]
for r in ipv4.routes {
let ipv4Route = NEIPv4Route(destinationAddress: r.destination, subnetMask: r.mask)
ipv4Route.gatewayAddress = r.gateway ?? ipv4.defaultGateway
routes.append(ipv4Route)
}
ipv4Settings = NEIPv4Settings(addresses: [ipv4.address], subnetMasks: [ipv4.addressMask])
ipv4Settings?.includedRoutes = routes
ipv4Settings?.excludedRoutes = []
}
var ipv6Settings: NEIPv6Settings?
if let ipv6 = reply.ipv6 {
let defaultRoute = NEIPv6Route.default()
defaultRoute.gatewayAddress = ipv6.defaultGateway
var routes: [NEIPv6Route] = [defaultRoute]
for r in ipv6.routes {
let ipv6Route = NEIPv6Route(destinationAddress: r.destination, networkPrefixLength: r.prefixLength as NSNumber)
ipv6Route.gatewayAddress = r.gateway ?? ipv6.defaultGateway
routes.append(ipv6Route)
}
ipv6Settings = NEIPv6Settings(addresses: [ipv6.address], networkPrefixLengths: [ipv6.addressPrefixLength as NSNumber])
ipv6Settings?.includedRoutes = [defaultRoute]
ipv6Settings?.excludedRoutes = []
}
2018-08-23 08:19:25 +00:00
let dnsSettings = NEDNSSettings(servers: cfg.sessionConfiguration.dnsServers ?? reply.dnsServers)
2018-08-23 08:19:25 +00:00
let newSettings = NEPacketTunnelNetworkSettings(tunnelRemoteAddress: remoteAddress)
newSettings.ipv4Settings = ipv4Settings
newSettings.ipv6Settings = ipv6Settings
2018-08-23 08:19:25 +00:00
newSettings.dnsSettings = dnsSettings
setTunnelNetworkSettings(newSettings, completionHandler: completionHandler)
}
}
extension TunnelKitProvider {
private func tryNextProtocol() -> Bool {
guard strategy.tryNextProtocol() else {
disposeTunnel(error: ProviderError.exhaustedProtocols)
return false
}
return true
}
2018-08-23 08:19:25 +00:00
// MARK: Logging
2018-08-23 08:19:25 +00:00
private func configureLogging(debug: Bool, customFormat: String? = nil) {
let logLevel: SwiftyBeaver.Level = (debug ? .debug : .info)
let logFormat = customFormat ?? "$Dyyyy-MM-dd HH:mm:ss.SSS$d $L $N.$F:$l - $M"
if debug {
let console = ConsoleDestination()
console.useNSLog = true
console.minLevel = logLevel
console.format = logFormat
log.addDestination(console)
}
let memory = memoryLog
memory.minLevel = logLevel
memory.format = logFormat
memory.maxLines = maxLogLines
log.addDestination(memoryLog)
}
private func flushLog() {
log.debug("Flushing log...")
if let url = cfg.urlForLog(in: appGroup) {
memoryLog.flush(to: url)
2018-08-23 08:19:25 +00:00
}
}
private func logCurrentSSID() {
if let ssid = observer.currentWifiNetworkName() {
2018-10-24 16:25:04 +00:00
log.debug("Current SSID: '\(ssid.maskedDescription)'")
} else {
log.debug("Current SSID: none (disconnected from WiFi)")
}
}
// private func anyPointer(_ object: Any?) -> UnsafeMutableRawPointer {
// let anyObject = object as AnyObject
// return Unmanaged<AnyObject>.passUnretained(anyObject).toOpaque()
// }
// MARK: Errors
private func setErrorStatus(with error: Error) {
defaults?.set(unifiedError(from: error).rawValue, forKey: Configuration.lastErrorKey)
}
private func unifiedError(from error: Error) -> ProviderError {
if let te = error.tunnelKitErrorCode() {
switch te {
case .cryptoBoxRandomGenerator, .cryptoBoxAlgorithm:
return .encryptionInitialization
case .cryptoBoxEncryption, .cryptoBoxHMAC:
return .encryptionData
case .tlsBoxCA, .tlsBoxClientCertificate, .tlsBoxClientKey:
return .tlsInitialization
case .tlsBoxServerCertificate, .tlsBoxServerEKU:
return .tlsServerVerification
case .tlsBoxHandshake:
return .tlsHandshake
case .dataPathOverflow, .dataPathPeerIdMismatch:
return .unexpectedReply
case .dataPathCompression:
return .serverCompression
case .LZO:
return .lzo
}
} else if let se = error as? SessionError {
switch se {
case .negotiationTimeout, .pingTimeout, .staleSession:
return .timeout
case .badCredentials:
return .authentication
case .serverCompression:
return .serverCompression
case .failedLinkWrite:
return .linkError
default:
return .unexpectedReply
}
2018-08-23 08:19:25 +00:00
}
return error as? ProviderError ?? .linkError
2018-08-23 08:19:25 +00:00
}
}