// SPDX-License-Identifier: MIT // Copyright © 2018 WireGuard LLC. All Rights Reserved. import Foundation import NetworkExtension import os.log protocol TunnelsManagerDelegate: class { func tunnelAdded(at: Int) func tunnelModified(at: Int) func tunnelsChanged() func tunnelRemoved(at: Int) } enum TunnelActivationError: Error { case noEndpoint case dnsResolutionFailed case tunnelOperationFailed case attemptingActivationWhenAnotherTunnelIsActive case attemptingActivationWhenTunnelIsNotInactive case attemptingDeactivationWhenTunnelIsInactive } class TunnelsManager { var tunnels: [TunnelContainer] weak var delegate: TunnelsManagerDelegate? = nil private var isAddingTunnel: Bool = false private var isModifyingTunnel: Bool = false private var isDeletingTunnel: Bool = false private var tunnelNames: Set private var currentTunnel: TunnelContainer? private var currentTunnelStatusObservationToken: AnyObject? init(tunnelProviders: [NETunnelProviderManager]) { var tunnelNames: Set = [] var tunnels = tunnelProviders.map { TunnelContainer(tunnel: $0, index: 0) } tunnels.sort { $0.name < $1.name } var currentTunnel: TunnelContainer? = nil for i in 0 ..< tunnels.count { let tunnel = tunnels[i] tunnel.index = i tunnelNames.insert(tunnel.name) if (tunnel.status != .inactive) { currentTunnel = tunnel } } self.tunnels = tunnels self.tunnelNames = tunnelNames if let currentTunnel = currentTunnel { setCurrentTunnel(tunnel: currentTunnel) } } static func create(completionHandler: @escaping (TunnelsManager?) -> Void) { NETunnelProviderManager.loadAllFromPreferences { (managers, error) in if let error = error { os_log("Failed to load tunnel provider managers: %{public}@", log: OSLog.default, type: .debug, "\(error)") return } completionHandler(TunnelsManager(tunnelProviders: managers ?? [])) } } func containsTunnel(named name: String) -> Bool { return tunnelNames.contains(name) } private func insertionIndexFor(tunnelName: String) -> Int { // Wishlist: Use binary search instead for i in 0 ..< tunnels.count { if (tunnelName.lexicographicallyPrecedes(tunnels[i].name)) { return i } } return tunnels.count } func add(tunnelConfiguration: TunnelConfiguration, completionHandler: @escaping (TunnelContainer?, Error?) -> Void) { let tunnelName = tunnelConfiguration.interface.name assert(!tunnelName.isEmpty) assert(!containsTunnel(named: tunnelName)) isAddingTunnel = true let tunnelProviderManager = NETunnelProviderManager() tunnelProviderManager.protocolConfiguration = NETunnelProviderProtocol(tunnelConfiguration: tunnelConfiguration) tunnelProviderManager.localizedDescription = tunnelName tunnelProviderManager.isEnabled = true tunnelProviderManager.saveToPreferences { [weak self] (error) in defer { self?.isAddingTunnel = false } guard (error == nil) else { completionHandler(nil, error) return } if let s = self { let index = s.insertionIndexFor(tunnelName: tunnelName) let tunnel = TunnelContainer(tunnel: tunnelProviderManager, index: index) for i in index ..< s.tunnels.count { s.tunnels[i].index = s.tunnels[i].index + 1 } s.tunnels.insert(tunnel, at: index) s.tunnelNames.insert(tunnel.name) s.delegate?.tunnelAdded(at: index) completionHandler(tunnel, nil) } } } func addMultiple(tunnelConfigurations: [TunnelConfiguration], completionHandler: @escaping (Int, Error?) -> Void) { addMultiple(tunnelConfigurations: tunnelConfigurations[0...], completionHandler: completionHandler) } private func addMultiple(tunnelConfigurations: ArraySlice, completionHandler: @escaping (Int, Error?) -> Void) { assert(!tunnelConfigurations.isEmpty) let head = tunnelConfigurations.first! let tail = tunnelConfigurations[1 ..< tunnelConfigurations.count] self.add(tunnelConfiguration: head) { [weak self] (tunnel, error) in if (error != nil) { completionHandler(tail.count, error) } else if (tail.isEmpty) { completionHandler(0, nil) } else { DispatchQueue.main.async { self?.addMultiple(tunnelConfigurations: tail, completionHandler: completionHandler) } } } } func modify(tunnel: TunnelContainer, with tunnelConfiguration: TunnelConfiguration, completionHandler: @escaping (Error?) -> Void) { let tunnelName = tunnelConfiguration.interface.name assert(!tunnelName.isEmpty) isModifyingTunnel = true let tunnelProviderManager = tunnel.tunnelProvider let isNameChanged = (tunnelName != tunnelProviderManager.localizedDescription) var oldName: String? = nil if (isNameChanged) { assert(!containsTunnel(named: tunnelName)) oldName = tunnel.name tunnel.name = tunnelName } tunnelProviderManager.protocolConfiguration = NETunnelProviderProtocol(tunnelConfiguration: tunnelConfiguration) tunnelProviderManager.localizedDescription = tunnelName tunnelProviderManager.isEnabled = true tunnelProviderManager.saveToPreferences { [weak self] (error) in defer { self?.isModifyingTunnel = false } guard (error != nil) else { completionHandler(error) return } if let s = self { if (isNameChanged) { s.tunnels.remove(at: tunnel.index) s.tunnelNames.remove(oldName!) for i in tunnel.index ..< s.tunnels.count { s.tunnels[i].index = s.tunnels[i].index - 1 } let index = s.insertionIndexFor(tunnelName: tunnelName) tunnel.index = index for i in index ..< s.tunnels.count { s.tunnels[i].index = s.tunnels[i].index + 1 } s.tunnels.insert(tunnel, at: index) s.tunnelNames.insert(tunnel.name) s.delegate?.tunnelsChanged() } else { s.delegate?.tunnelModified(at: tunnel.index) } completionHandler(nil) } } } func remove(tunnel: TunnelContainer, completionHandler: @escaping (Error?) -> Void) { let tunnelProviderManager = tunnel.tunnelProvider let tunnelIndex = tunnel.index let tunnelName = tunnel.name isDeletingTunnel = true tunnelProviderManager.removeFromPreferences { [weak self] (error) in defer { self?.isDeletingTunnel = false } guard (error == nil) else { completionHandler(error) return } if let s = self { for i in ((tunnelIndex + 1) ..< s.tunnels.count) { s.tunnels[i].index = s.tunnels[i].index + 1 } s.tunnels.remove(at: tunnelIndex) s.tunnelNames.remove(tunnelName) s.delegate?.tunnelRemoved(at: tunnelIndex) } completionHandler(nil) } } func numberOfTunnels() -> Int { return tunnels.count } func tunnel(at index: Int) -> TunnelContainer { return tunnels[index] } func startActivation(of tunnel: TunnelContainer, completionHandler: @escaping (Error?) -> Void) { guard (tunnel.status == .inactive) else { completionHandler(TunnelActivationError.attemptingActivationWhenTunnelIsNotInactive) return } guard (currentTunnel == nil) else { completionHandler(TunnelActivationError.attemptingActivationWhenAnotherTunnelIsActive) return } tunnel.startActivation(completionHandler: completionHandler) setCurrentTunnel(tunnel: tunnel) } func startDeactivation(of tunnel: TunnelContainer, completionHandler: @escaping (Error?) -> Void) { if (tunnel.status == .inactive) { completionHandler(TunnelActivationError.attemptingDeactivationWhenTunnelIsInactive) return } assert(tunnel.index == currentTunnel!.index) tunnel.startDeactivation() } private func setCurrentTunnel(tunnel: TunnelContainer) { currentTunnel = tunnel currentTunnelStatusObservationToken = tunnel.observe(\.status) { [weak self] (tunnel, change) in guard let s = self else { return } if (tunnel.status == .inactive) { s.currentTunnel = nil s.currentTunnelStatusObservationToken = nil } } } } extension NETunnelProviderProtocol { convenience init?(tunnelConfiguration: TunnelConfiguration) { assert(!tunnelConfiguration.interface.name.isEmpty) guard let serializedTunnelConfiguration = try? JSONEncoder().encode(tunnelConfiguration) else { return nil } self.init() let appId = Bundle.main.bundleIdentifier! let firstValidEndpoint = tunnelConfiguration.peers.first(where: { $0.endpoint != nil })?.endpoint providerBundleIdentifier = "\(appId).WireGuardNetworkExtension" providerConfiguration = [ "tunnelConfiguration": serializedTunnelConfiguration, "tunnelConfigurationVersion": 1 ] serverAddress = firstValidEndpoint?.stringRepresentation() ?? "Unspecified" username = tunnelConfiguration.interface.name } func tunnelConfiguration() -> TunnelConfiguration? { guard let serializedTunnelConfiguration = providerConfiguration?["tunnelConfiguration"] as? Data else { return nil } return try? JSONDecoder().decode(TunnelConfiguration.self, from: serializedTunnelConfiguration) } } class TunnelContainer: NSObject { @objc dynamic var name: String @objc dynamic var status: TunnelStatus fileprivate let tunnelProvider: NETunnelProviderManager fileprivate var index: Int fileprivate var statusObservationToken: AnyObject? private var dnsResolver: DNSResolver? = nil init(tunnel: NETunnelProviderManager, index: Int) { self.name = tunnel.localizedDescription ?? "Unnamed" let status = TunnelStatus(from: tunnel.connection.status) self.status = status self.tunnelProvider = tunnel self.index = index super.init() if (status != .inactive) { startObservingTunnelStatus() } } func tunnelConfiguration() -> TunnelConfiguration? { return (tunnelProvider.protocolConfiguration as! NETunnelProviderProtocol).tunnelConfiguration() } fileprivate func startActivation(completionHandler: @escaping (Error?) -> Void) { assert(status == .inactive) assert(self.dnsResolver == nil) guard let tunnelConfiguration = tunnelConfiguration() else { fatalError() } let endpoints = tunnelConfiguration.peers.map { $0.endpoint } // Ensure there's a tunner server address we can give to iOS guard (endpoints.contains(where: { $0 != nil })) else { DispatchQueue.main.async { [weak self] in self?.status = .inactive completionHandler(TunnelActivationError.noEndpoint) } return } // Resolve DNS and start the tunnel let dnsResolver = DNSResolver(endpoints: endpoints) let resolvedEndpoints = dnsResolver.resolveWithoutNetworkRequests() if let resolvedEndpoints = resolvedEndpoints { // If we don't have to make a DNS network request, we never // change the status to .resolvingEndpointDomains startActivation(tunnelConfiguration: tunnelConfiguration, resolvedEndpoints: resolvedEndpoints, completionHandler: completionHandler) } else { status = .resolvingEndpointDomains self.dnsResolver = dnsResolver dnsResolver.resolve { [weak self] resolvedEndpoints in guard let s = self else { return } assert(s.status == .resolvingEndpointDomains) s.dnsResolver = nil guard let resolvedEndpoints = resolvedEndpoints else { s.status = .inactive completionHandler(TunnelActivationError.dnsResolutionFailed) return } s.startActivation(tunnelConfiguration: tunnelConfiguration, resolvedEndpoints: resolvedEndpoints, completionHandler: completionHandler) } } } fileprivate func startActivation(recursionCount: UInt = 0, lastError: Error? = nil, tunnelConfiguration: TunnelConfiguration, resolvedEndpoints: [Endpoint?], completionHandler: @escaping (Error?) -> Void) { if (recursionCount >= 8) { os_log("startActivation: Failed after 8 attempts. Giving up with %{public}@.", log: OSLog.default, type: .error, "\(lastError!)") completionHandler(lastError) return } // resolvedEndpoints should contain only IP addresses, not any named endpoints assert(resolvedEndpoints.allSatisfy { (resolvedEndpoint) in guard let resolvedEndpoint = resolvedEndpoint else { return true } switch (resolvedEndpoint.host) { case .ipv4(_): return true case .ipv6(_): return true case .name(_, _): return false } }) os_log("startActivation: Entering", log: OSLog.default, type: .debug) guard (tunnelProvider.isEnabled) else { // In case the tunnel had gotten disabled, re-enable and save it, // then call this function again. os_log("startActivation: Tunnel is disabled. Re-enabling and saving.", log: OSLog.default, type: .info) tunnelProvider.isEnabled = true tunnelProvider.saveToPreferences { [weak self] (error) in if (error != nil) { os_log("Error saving tunnel after re-enabling: %{public}@", log: OSLog.default, type: .error, "\(error!)") completionHandler(error) return } os_log("startActivation: Tunnel saved after re-enabling.", log: OSLog.default, type: .info) os_log("startActivation: Invoking startActivation", log: OSLog.default, type: .debug) self?.startActivation(recursionCount: recursionCount + 1, lastError: NEVPNError(NEVPNError.configurationUnknown), tunnelConfiguration: tunnelConfiguration, resolvedEndpoints: resolvedEndpoints, completionHandler: completionHandler) } return } // Start the tunnel startObservingTunnelStatus() let session = (tunnelProvider.connection as! NETunnelProviderSession) do { os_log("startActivation: Generating options", log: OSLog.default, type: .debug) let tunnelOptions = PacketTunnelOptionsGenerator.generateOptions( from: tunnelConfiguration, withResolvedEndpoints: resolvedEndpoints) os_log("startActivation: Starting tunnel", log: OSLog.default, type: .debug) try session.startTunnel(options: tunnelOptions) os_log("startActivation: Success", log: OSLog.default, type: .debug) completionHandler(nil) } catch (let error) { os_log("startActivation: Error starting tunnel. Examining error.", log: OSLog.default, type: .debug) guard let vpnError = error as? NEVPNError else { os_log("Failed to activate tunnel: %{public}@", log: OSLog.default, type: .debug, "\(error)") status = .inactive completionHandler(error) return } guard (vpnError.code == NEVPNError.configurationInvalid || vpnError.code == NEVPNError.configurationStale) else { os_log("Failed to activate tunnel: %{public}@", log: OSLog.default, type: .debug, "\(error)") status = .inactive completionHandler(error) return } assert(vpnError.code == NEVPNError.configurationInvalid || vpnError.code == NEVPNError.configurationStale) os_log("startActivation: Error says: %{public}@", log: OSLog.default, type: .debug, vpnError.code == NEVPNError.configurationInvalid ? "Configuration invalid" : "Configuration stale") os_log("startActivation: Will reload tunnel and then try to start it. ", log: OSLog.default, type: .info) tunnelProvider.loadFromPreferences { [weak self] (error) in if (error != nil) { os_log("Failed to activate tunnel: %{public}@", log: OSLog.default, type: .debug, "\(error!)") self?.status = .inactive completionHandler(error) return } os_log("startActivation: Tunnel reloaded.", log: OSLog.default, type: .info) os_log("startActivation: Invoking startActivation", log: OSLog.default, type: .debug) self?.startActivation(recursionCount: recursionCount + 1, lastError: vpnError, tunnelConfiguration: tunnelConfiguration, resolvedEndpoints: resolvedEndpoints, completionHandler: completionHandler) } } } fileprivate func startDeactivation() { assert(status == .active) assert(statusObservationToken != nil) let session = (tunnelProvider.connection as! NETunnelProviderSession) session.stopTunnel() } private func startObservingTunnelStatus() { if (statusObservationToken != nil) { return } let connection = tunnelProvider.connection statusObservationToken = NotificationCenter.default.addObserver( forName: .NEVPNStatusDidChange, object: connection, queue: nil) { [weak self] (_) in let status = TunnelStatus(from: connection.status) if let s = self { s.status = status if (status == .inactive) { s.stopObservingTunnelStatus() } } } } private func stopObservingTunnelStatus() { DispatchQueue.main.async { [weak self] in self?.statusObservationToken = nil } } } @objc enum TunnelStatus: Int { case inactive case activating case active case deactivating case reasserting // On editing an active tunnel, the tunnel shall deactive and then activate case resolvingEndpointDomains // DNS resolution in progress init(from vpnStatus: NEVPNStatus) { switch (vpnStatus) { case .connected: self = .active case .connecting: self = .activating case .disconnected: self = .inactive case .disconnecting: self = .deactivating case .reasserting: self = .reasserting case .invalid: self = .inactive } } }