mobile_nebula/ios/NebulaNetworkExtension/PacketTunnelProvider.swift

import NetworkExtension
import MobileNebula
import os.log
import SwiftyJSON

class PacketTunnelProvider: NEPacketTunnelProvider {
    private var networkMonitor: NWPathMonitor?
    private var ifname: String?
    
    private var site: Site?
    private var _log = OSLog(subsystem: "net.defined.mobileNebula", category: "PacketTunnelProvider")
    private var nebula: MobileNebulaNebula?
    private var didSleep = false
    private var cachedRouteDescription: String?
    
    // This is the system completionHandler, only set when we expect the UI to ask us to actually start so that errors can flow back to the UI
    private var startCompleter: ((Error?) -> Void)?
    
    private func log(_ message: StaticString, _ args: Any...) {
        os_log(message, log: _log, args)
    }
    
    override func startTunnel(options: [String : NSObject]?, completionHandler: @escaping (Error?) -> Void) {       
        // There is currently no way to get initialization errors back to the UI via completionHandler here
        // `expectStart` is sent only via the UI which means we should wait for the real start command which has another completion handler the UI can intercept
        // In the end we need to call this completionHandler to inform the system of our state
        if options?["expectStart"] != nil {
            startCompleter = completionHandler
            return
        }
        
        // VPN is being booted out of band of the UI. Use the system completion handler as there will be nothing to route initialization errors to but we still need to report
        // success/fail by the presence of an error or nil
        start(completionHandler: completionHandler)
    }
    
    private func start(completionHandler: @escaping (Error?) -> Void) {
        let proto = self.protocolConfiguration as! NETunnelProviderProtocol
        var config: Data
        var key: String

        do {
            config = proto.providerConfiguration?["config"] as! Data
            site = try Site(proto: proto)
        } catch {
            //TODO: need a way to notify the app
            log("Failed to render config from vpn object")
            return completionHandler(error)
        }

        let _site = site!
        _log = OSLog(subsystem: "net.defined.mobileNebula:\(_site.name)", category: "PacketTunnelProvider")

        do {
            key = try _site.getKey()
        } catch {
            return completionHandler(error)
        }

        let fileDescriptor = (self.packetFlow.value(forKeyPath: "socket.fileDescriptor") as? Int32) ?? -1
        if fileDescriptor < 0 {
            return completionHandler("Starting tunnel failed: Could not determine file descriptor")
        }

        var ifnameSize = socklen_t(IFNAMSIZ)
        let ifnamePtr = UnsafeMutablePointer<CChar>.allocate(capacity: Int(ifnameSize))
        ifnamePtr.initialize(repeating: 0, count: Int(ifnameSize))
        if getsockopt(fileDescriptor, 2 /* SYSPROTO_CONTROL */, 2 /* UTUN_OPT_IFNAME */, ifnamePtr, &ifnameSize) == 0 {
            self.ifname = String(cString: ifnamePtr)
        }
        ifnamePtr.deallocate()

        // This is set to 127.0.0.1 because it has to be something..
        let tunnelNetworkSettings = NEPacketTunnelNetworkSettings(tunnelRemoteAddress: "127.0.0.1")

        // Make sure our ip is routed to the tun device
        var err: NSError?
        let ipNet = MobileNebulaParseCIDR(_site.cert!.cert.details.ips[0], &err)
        if (err != nil) {
            return completionHandler(err!)
        }
        tunnelNetworkSettings.ipv4Settings = NEIPv4Settings(addresses: [ipNet!.ip], subnetMasks: [ipNet!.maskCIDR])
        var routes: [NEIPv4Route] = [NEIPv4Route(destinationAddress: ipNet!.network, subnetMask: ipNet!.maskCIDR)]

        // Add our unsafe routes
        _site.unsafeRoutes.forEach { unsafeRoute in
            let ipNet = MobileNebulaParseCIDR(unsafeRoute.route, &err)
            if (err != nil) {
                return completionHandler(err!)
            }
            routes.append(NEIPv4Route(destinationAddress: ipNet!.network, subnetMask: ipNet!.maskCIDR))
        }

        tunnelNetworkSettings.ipv4Settings!.includedRoutes = routes
        tunnelNetworkSettings.mtu = _site.mtu as NSNumber

        self.setTunnelNetworkSettings(tunnelNetworkSettings, completionHandler: {(error:Error?) in
            if (error != nil) {
                return completionHandler(error!)
            }

            var err: NSError?
            self.nebula = MobileNebulaNewNebula(String(data: config, encoding: .utf8), key, self.site!.logFile, Int(fileDescriptor), &err)
            self.startNetworkMonitor()

            if err != nil {
                return completionHandler(err!)
            }

            self.nebula!.start()
            completionHandler(nil)
        })
    }
    
//TODO: Sleep/wake get called aggresively and do nothing to help us here, we should locate why that is and make these work appropriately
//    override func sleep(completionHandler: @escaping () -> Void) {
//        nebula!.sleep()
//        completionHandler()
//    }
    
    private func startNetworkMonitor() {
        networkMonitor = NWPathMonitor()
        networkMonitor!.pathUpdateHandler = self.pathUpdate
        networkMonitor!.start(queue: DispatchQueue(label: "NetworkMonitor"))
    }
    
    private func stopNetworkMonitor() {
        self.networkMonitor?.cancel()
        networkMonitor = nil
    }
    
    override func stopTunnel(with reason: NEProviderStopReason, completionHandler: @escaping () -> Void) {
        nebula?.stop()
        stopNetworkMonitor()
        completionHandler()
    }
        
    private func pathUpdate(path: Network.NWPath) {
        let routeDescription = collectAddresses(endpoints: path.gateways)
        if routeDescription != cachedRouteDescription {
            // Don't bother to rebind if we don't have any gateways
            if routeDescription != "" {
                nebula?.rebind("network change to: \(routeDescription); from: \(cachedRouteDescription ?? "none")")
            }
            cachedRouteDescription = routeDescription
        }
    }
    
    private func collectAddresses(endpoints: [Network.NWEndpoint]) -> String {
        var str: [String] = []
        endpoints.forEach{ endpoint in
            switch endpoint {
            case let .hostPort(.ipv6(host), port):
                str.append("[\(host)]:\(port)")
            case let .hostPort(.ipv4(host), port):
                str.append("\(host):\(port)")
            default:
                return
            }
        }
        
        return str.sorted().joined(separator: ", ")
    }
    
    override func handleAppMessage(_ data: Data, completionHandler: ((Data?) -> Void)? = nil) {
        guard let call = try? JSONDecoder().decode(IPCRequest.self, from: data) else {
            log("Failed to decode IPCRequest from network extension")
            return
        }
        
        var error: Error?
        var data: JSON?
        
        // start command has special treatment due to needing to call two completers
        if call.command == "start" {
            self.start() { error in
                // Notify the system of our start result
                if self.startCompleter != nil {
                    if error == nil {
                        // Clean boot, no errors
                        self.startCompleter!(nil)
                        
                    } else {
                        // We encountered an error, we can just pass NSError() here since ios throws it away
                        // But we will provide it in the event we can intercept the error without doing this workaround sometime in the future
                        self.startCompleter!(error!.localizedDescription)
                    }
                }
                
                // Notify the UI if we have a completionHandler
                if completionHandler != nil {
                    if error == nil {
                        // No response data, this is expected on a clean start
                        completionHandler!(try? JSONEncoder().encode(IPCResponse.init(type: .success, message: nil)))
                        
                    } else {
                        // Error response has
                        completionHandler!(try? JSONEncoder().encode(IPCResponse.init(type: .error, message: JSON(error!.localizedDescription))))
                    }
                }
            }
            return
        }
        
        if nebula == nil {
            // Respond with an empty success message in the event a command comes in before we've truly started
            log("Received command but do not have a nebula instance")
            return completionHandler!(try? JSONEncoder().encode(IPCResponse.init(type: .success, message: nil)))
        }
        
        //TODO: try catch over all this
        switch call.command {
        case "listHostmap": (data, error) = listHostmap(pending: false)
        case "listPendingHostmap": (data, error) = listHostmap(pending: true)
        case "getHostInfo": (data, error) = getHostInfo(args: call.arguments!)
        case "setRemoteForTunnel": (data, error) = setRemoteForTunnel(args: call.arguments!)
        case "closeTunnel": (data, error) = closeTunnel(args: call.arguments!)
            
        default:
            error = "Unknown IPC message type \(call.command)"
        }
        
        if (error != nil) {
            completionHandler!(try? JSONEncoder().encode(IPCResponse.init(type: .error, message: JSON(error?.localizedDescription ?? "Unknown error"))))
        } else {
            completionHandler!(try? JSONEncoder().encode(IPCResponse.init(type: .success, message: data)))
        }
    }
    
    private func listHostmap(pending: Bool) -> (JSON?, Error?) {
        var err: NSError?
        let res = nebula!.listHostmap(pending, error: &err)
        return (JSON(res), err)
    }
    
    private func getHostInfo(args: JSON) -> (JSON?, Error?) {
        var err: NSError?
        let res = nebula!.getHostInfo(byVpnIp: args["vpnIp"].string, pending: args["pending"].boolValue, error: &err)
        return (JSON(res), err)
    }
    
    private func setRemoteForTunnel(args: JSON) -> (JSON?, Error?) {
        var err: NSError?
        let res = nebula!.setRemoteForTunnel(args["vpnIp"].string, addr: args["addr"].string, error: &err)
        return (JSON(res), err)
    }
    
    private func closeTunnel(args: JSON) -> (JSON?, Error?) {
        let res = nebula!.closeTunnel(args["vpnIp"].string)
        return (JSON(res), nil)
    }
}