Parse and apply IPv6 settings when available

IPv4 currently mandatory in PushReply (exception otherwise).

TunnelKit/Sources/AppExtension/TunnelKitProvider.swift

@@ -458,8 +458,8 @@ extension TunnelKitProvider: SessionProxyDelegate {
         
         log.info("Returned ifconfig parameters:")
         log.info("\tRemote: \(remoteAddress)")
-        log.info("\tLocal: \(reply.address)/\(reply.addressMask)")
+        log.info("\tIPv4: \(reply.ipv4?.description ?? "not configured")")
-        log.info("\tGateway: \(reply.defaultGateway)")
+        log.info("\tIPv6: \(reply.ipv6?.description ?? "not configured")")
         log.info("\tDNS: \(reply.dnsServers)")
         
         bringNetworkUp(remoteAddress: remoteAddress, reply: reply) { (error) in
@@ -492,24 +492,45 @@ extension TunnelKitProvider: SessionProxyDelegate {
     private func bringNetworkUp(remoteAddress: String, reply: SessionReply, completionHandler: @escaping (Error?) -> Void) {
         
         // route all traffic to VPN
+        var ipv4Settings: NEIPv4Settings?
+        if let ipv4 = reply.ipv4 {
             let defaultRoute = NEIPv4Route.default()
-        defaultRoute.gatewayAddress = reply.defaultGateway
+            defaultRoute.gatewayAddress = ipv4.defaultGateway
             
             var routes: [NEIPv4Route] = [defaultRoute]
-        for r in reply.routes {
+            for r in ipv4.routes {
                 let ipv4Route = NEIPv4Route(destinationAddress: r.destination, subnetMask: r.mask)
-            ipv4Route.gatewayAddress = r.gateway ?? reply.defaultGateway
+                ipv4Route.gatewayAddress = r.gateway ?? ipv4.defaultGateway
                 routes.append(ipv4Route)
             }
             
-        let ipv4Settings = NEIPv4Settings(addresses: [reply.address], subnetMasks: [reply.addressMask])
+            ipv4Settings = NEIPv4Settings(addresses: [ipv4.address], subnetMasks: [ipv4.addressMask])
-        ipv4Settings.includedRoutes = routes
+            ipv4Settings?.includedRoutes = routes
-        ipv4Settings.excludedRoutes = []
+            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 = []
+        }
         
         let dnsSettings = NEDNSSettings(servers: reply.dnsServers)
         
         let newSettings = NEPacketTunnelNetworkSettings(tunnelRemoteAddress: remoteAddress)
         newSettings.ipv4Settings = ipv4Settings
+        newSettings.ipv6Settings = ipv6Settings
         newSettings.dnsSettings = dnsSettings
         
         setTunnelNetworkSettings(newSettings, completionHandler: completionHandler)

TunnelKit/Sources/Core/SessionProxy+PushReply.swift

@@ -37,28 +37,8 @@
 
 import Foundation
 
-/// Represents the reply of a successful session start.
+/// Encapsulates the IPv4 settings for the tunnel.
-public protocol SessionReply {
+public struct IPv4Settings: CustomStringConvertible {
-
-    /// The obtained address.
-    var address: String { get }
-
-    /// The obtained address mask.
-    var addressMask: String { get }
-
-    /// The address of the default gateway.
-    var defaultGateway: String { get }
-
-    /// The additional routes.
-    var routes: [SessionProxy.Route] { get }
-
-    /// The DNS servers set up for this session.
-    var dnsServers: [String] { get }
-}
-
-extension SessionProxy {
-
-    // XXX: parsing is very optimistic
 
     /// Represents a route in the routing table.
     public struct Route {
@@ -79,6 +59,85 @@ extension SessionProxy {
         }
     }
 
+    /// The address.
+    let address: String
+    
+    /// The address mask.
+    let addressMask: String
+    
+    /// The address of the default gateway.
+    let defaultGateway: String
+
+    /// The additional routes.
+    let routes: [Route]
+
+    // MARK: CustomStringConvertible
+
+    /// :nodoc:
+    public var description: String {
+        return "addr \(address) netmask \(addressMask) gw \(defaultGateway)"
+    }
+}
+
+/// Encapsulates the IPv6 settings for the tunnel.
+public struct IPv6Settings: CustomStringConvertible {
+
+    /// Represents a route in the routing table.
+    public struct Route {
+
+        /// The destination host or subnet.
+        public let destination: String
+        
+        /// The address prefix length.
+        public let prefixLength: UInt8
+        
+        /// The address of the gateway (uses default gateway if not set).
+        public let gateway: String?
+        
+        fileprivate init(_ destination: String, _ prefixLength: UInt8?, _ gateway: String?) {
+            self.destination = destination
+            self.prefixLength = prefixLength ?? 3
+            self.gateway = gateway
+        }
+    }
+
+    /// The address.
+    public let address: String
+    
+    /// The address prefix length.
+    public let addressPrefixLength: UInt8
+    
+    /// The address of the default gateway.
+    public let defaultGateway: String
+    
+    /// The additional routes.
+    public let routes: [Route]
+
+    // MARK: CustomStringConvertible
+    
+    /// :nodoc:
+    public var description: String {
+        return "addr \(address)/\(addressPrefixLength) gw \(defaultGateway)"
+    }
+}
+
+/// Groups the parsed reply of a successfully started session.
+public protocol SessionReply {
+
+    /// The IPv4 settings.
+    var ipv4: IPv4Settings? { get }
+    
+    /// The IPv6 settings.
+    var ipv6: IPv6Settings? { get }
+    
+    /// The DNS servers set up for this session.
+    var dnsServers: [String] { get }
+}
+
+extension SessionProxy {
+
+    // XXX: parsing is very optimistic
+    
     struct PushReply: SessionReply {
         private enum Topology: String {
             case net30
@@ -92,23 +151,23 @@ extension SessionProxy {
         
         private static let ifconfigRegexp = try! NSRegularExpression(pattern: "ifconfig [\\d\\.]+ [\\d\\.]+", options: [])
 
+        private static let ifconfig6Regexp = try! NSRegularExpression(pattern: "ifconfig-ipv6 [\\da-fA-F:]+/\\d+ [\\da-fA-F:]+", options: [])
+
         private static let gatewayRegexp = try! NSRegularExpression(pattern: "route-gateway [\\d\\.]+", options: [])
         
         private static let routeRegexp = try! NSRegularExpression(pattern: "route [\\d\\.]+( [\\d\\.]+){0,2}", options: [])
 
+        private static let route6Regexp = try! NSRegularExpression(pattern: "route-ipv6 [\\da-fA-F:]+/\\d+( [\\da-fA-F:]+){0,2}", options: [])
+
         private static let dnsRegexp = try! NSRegularExpression(pattern: "dhcp-option DNS6? [\\d\\.a-fA-F:]+", options: [])
 
         private static let authTokenRegexp = try! NSRegularExpression(pattern: "auth-token [a-zA-Z0-9/=+]+", options: [])
 
         private static let peerIdRegexp = try! NSRegularExpression(pattern: "peer-id [0-9]+", options: [])
 
-        let address: String
+        let ipv4: IPv4Settings?
         
-        let addressMask: String
+        let ipv6: IPv6Settings?
-
-        let defaultGateway: String
-
-        let routes: [Route]
         
         let dnsServers: [String]
         
@@ -122,18 +181,20 @@ extension SessionProxy {
             }
             
             var optTopologyComponents: [String]?
-            var optIfconfigComponents: [String]?
+            var optIfconfig4Components: [String]?
-            var optGatewayComponents: [String]?
+            var optGateway4Components: [String]?
+            let address4: String
+            let addressMask4: String
+            let defaultGateway4: String
+            var routes4: [IPv4Settings.Route] = []
+
+            var optIfconfig6Components: [String]?
 
-            let address: String
-            let addressMask: String
-            let defaultGateway: String
-            var routes: [Route] = []
             var dnsServers: [String] = []
             var authToken: String?
             var peerId: UInt32?
             
-            // MARK: Routing
+            // MARK: Routing (IPv4)
 
             PushReply.topologyRegexp.enumerateMatches(in: message, options: [], range: NSMakeRange(0, message.count)) { (result, flags, _) in
                 guard let range = result?.range else { return }
@@ -154,9 +215,9 @@ extension SessionProxy {
                 guard let range = result?.range else { return }
                 
                 let match = (message as NSString).substring(with: range)
-                optIfconfigComponents = match.components(separatedBy: " ")
+                optIfconfig4Components = match.components(separatedBy: " ")
             }
-            guard let ifconfigComponents = optIfconfigComponents, ifconfigComponents.count == 3 else {
+            guard let ifconfig4Components = optIfconfig4Components, ifconfig4Components.count == 3 else {
                 throw SessionError.malformedPushReply
             }
             
@@ -164,7 +225,7 @@ extension SessionProxy {
                 guard let range = result?.range else { return }
 
                 let match = (message as NSString).substring(with: range)
-                optGatewayComponents = match.components(separatedBy: " ")
+                optGateway4Components = match.components(separatedBy: " ")
             }
             
             //
@@ -184,17 +245,102 @@ extension SessionProxy {
             case .subnet:
                 
                 // default gateway required when topology is subnet
-                guard let gatewayComponents = optGatewayComponents, gatewayComponents.count == 2 else {
+                guard let gateway4Components = optGateway4Components, gateway4Components.count == 2 else {
                     throw SessionError.malformedPushReply
                 }
-                address = ifconfigComponents[1]
+                address4 = ifconfig4Components[1]
-                addressMask = ifconfigComponents[2]
+                addressMask4 = ifconfig4Components[2]
-                defaultGateway = gatewayComponents[1]
+                defaultGateway4 = gateway4Components[1]
                 
             default:
-                address = ifconfigComponents[1]
+                address4 = ifconfig4Components[1]
-                addressMask = "255.255.255.255"
+                addressMask4 = "255.255.255.255"
-                defaultGateway = ifconfigComponents[2]
+                defaultGateway4 = ifconfig4Components[2]
+            }
+
+            PushReply.routeRegexp.enumerateMatches(in: message, options: [], range: NSMakeRange(0, message.count)) { (result, flags, _) in
+                guard let range = result?.range else { return }
+                
+                let match = (message as NSString).substring(with: range)
+                let routeEntryComponents = match.components(separatedBy: " ")
+                
+                let address = routeEntryComponents[1]
+                let mask: String?
+                let gateway: String?
+                if routeEntryComponents.count > 2 {
+                    mask = routeEntryComponents[2]
+                } else {
+                    mask = nil
+                }
+                if routeEntryComponents.count > 3 {
+                    gateway = routeEntryComponents[3]
+                } else {
+                    gateway = defaultGateway4
+                }
+                routes4.append(IPv4Settings.Route(address, mask, gateway))
+            }
+
+            ipv4 = IPv4Settings(
+                address: address4,
+                addressMask: addressMask4,
+                defaultGateway: defaultGateway4,
+                routes: routes4
+            )
+
+            // MARK: Routing (IPv6)
+            
+            PushReply.ifconfig6Regexp.enumerateMatches(in: message, options: [], range: NSMakeRange(0, message.count)) { (result, flags, _) in
+                guard let range = result?.range else { return }
+                
+                let match = (message as NSString).substring(with: range)
+                optIfconfig6Components = match.components(separatedBy: " ")
+            }
+            if let ifconfig6Components = optIfconfig6Components, ifconfig6Components.count == 3 {
+                let address6Components = ifconfig6Components[1].components(separatedBy: "/")
+                guard address6Components.count == 2 else {
+                    throw SessionError.malformedPushReply
+                }
+                guard let addressPrefix6 = UInt8(address6Components[1]) else {
+                    throw SessionError.malformedPushReply
+                }
+                let address6 = address6Components[0]
+                let defaultGateway6 = ifconfig6Components[2]
+                
+                var routes6: [IPv6Settings.Route] = []
+                PushReply.route6Regexp.enumerateMatches(in: message, options: [], range: NSMakeRange(0, message.count)) { (result, flags, _) in
+                    guard let range = result?.range else { return }
+                        
+                    let match = (message as NSString).substring(with: range)
+                    let routeEntryComponents = match.components(separatedBy: " ")
+                    
+                    let destinationComponents = routeEntryComponents[1].components(separatedBy: "/")
+                    guard destinationComponents.count == 2 else {
+//                        throw SessionError.malformedPushReply
+                        return
+                    }
+                    guard let prefix = UInt8(destinationComponents[1]) else {
+//                        throw SessionError.malformedPushReply
+                        return
+                    }
+
+                    let destination = destinationComponents[0]
+                    let gateway: String?
+                    if routeEntryComponents.count > 2 {
+                        gateway = routeEntryComponents[2]
+                    } else {
+                        gateway = defaultGateway6
+                    }
+                    routes6.append(IPv6Settings.Route(destination, prefix, gateway))
+                }
+
+                ipv6 = IPv6Settings(
+                    address: address6,
+                    addressPrefixLength: addressPrefix6,
+                    defaultGateway: defaultGateway6,
+                    routes: routes6
+                )
+            } else {
+                ipv6 = nil
             }
 
             // MARK: DNS
@@ -208,30 +354,6 @@ extension SessionProxy {
                 dnsServers.append(dnsEntryComponents[2])
             }
             
-            // MARK: Routes
-            
-            PushReply.routeRegexp.enumerateMatches(in: message, options: [], range: NSMakeRange(0, message.count)) { (result, flags, _) in
-                guard let range = result?.range else { return }
-
-                let match = (message as NSString).substring(with: range)
-                let routeEntryComponents = match.components(separatedBy: " ")
-
-                let destination = routeEntryComponents[1]
-                let mask: String?
-                let gateway: String?
-                if routeEntryComponents.count > 2 {
-                    mask = routeEntryComponents[2]
-                } else {
-                    mask = nil
-                }
-                if routeEntryComponents.count > 3 {
-                    gateway = routeEntryComponents[3]
-                } else {
-                    gateway = defaultGateway
-                }
-                routes.append(Route(destination, mask, gateway))
-            }
-            
             // MARK: Authentication
 
             PushReply.authTokenRegexp.enumerateMatches(in: message, options: [], range: NSMakeRange(0, message.count)) { (result, flags, _) in
@@ -256,11 +378,7 @@ extension SessionProxy {
                 }
             }
 
-            self.address = address
-            self.addressMask = addressMask
-            self.defaultGateway = defaultGateway
             self.dnsServers = dnsServers
-            self.routes = routes
             self.authToken = authToken
             self.peerId = peerId
         }

TunnelKitTests/PushTests.swift

@@ -28,9 +28,8 @@ import XCTest
 
 private extension SessionReply {
     func debug() {
-        print("Address: \(address)")
+        print("IPv4: \(ipv4?.description ?? "none")")
-        print("Mask: \(addressMask)")
+        print("IPv6: \(ipv6?.description ?? "none")")
-        print("Gateway: \(defaultGateway)")
         print("DNS: \(dnsServers)")
     }
 }
@@ -50,9 +49,9 @@ class PushTests: XCTestCase {
         let reply = try! SessionProxy.PushReply(message: msg)!
         reply.debug()
 
-        XCTAssertEqual(reply.address, "10.5.10.6")
+        XCTAssertEqual(reply.ipv4?.address, "10.5.10.6")
-        XCTAssertEqual(reply.addressMask, "255.255.255.255")
+        XCTAssertEqual(reply.ipv4?.addressMask, "255.255.255.255")
-        XCTAssertEqual(reply.defaultGateway, "10.5.10.5")
+        XCTAssertEqual(reply.ipv4?.defaultGateway, "10.5.10.5")
         XCTAssertEqual(reply.dnsServers, ["209.222.18.222", "209.222.18.218"])
     }
     
@@ -61,9 +60,9 @@ class PushTests: XCTestCase {
         let reply = try! SessionProxy.PushReply(message: msg)!
         reply.debug()
         
-        XCTAssertEqual(reply.address, "10.8.0.2")
+        XCTAssertEqual(reply.ipv4?.address, "10.8.0.2")
-        XCTAssertEqual(reply.addressMask, "255.255.255.0")
+        XCTAssertEqual(reply.ipv4?.addressMask, "255.255.255.0")
-        XCTAssertEqual(reply.defaultGateway, "10.8.0.1")
+        XCTAssertEqual(reply.ipv4?.defaultGateway, "10.8.0.1")
         XCTAssertEqual(reply.dnsServers, ["8.8.8.8", "4.4.4.4"])
     }
     
@@ -72,7 +71,7 @@ class PushTests: XCTestCase {
         let reply = try! SessionProxy.PushReply(message: msg)!
         reply.debug()
         
-        let route = reply.routes.first!
+        let route = reply.ipv4!.routes.first!
         
         XCTAssertEqual(route.destination, "192.168.0.0")
         XCTAssertEqual(route.mask, "255.255.255.0")
@@ -84,9 +83,12 @@ class PushTests: XCTestCase {
         let reply = try! SessionProxy.PushReply(message: msg)!
         reply.debug()
         
-//        XCTAssertEqual(reply.address, "10.5.10.6")
+        XCTAssertEqual(reply.ipv4?.address, "10.8.0.2")
-//        XCTAssertEqual(reply.addressMask, "255.255.255.255")
+        XCTAssertEqual(reply.ipv4?.addressMask, "255.255.255.0")
-//        XCTAssertEqual(reply.gatewayAddress, "10.5.10.5")
+        XCTAssertEqual(reply.ipv4?.defaultGateway, "10.8.0.1")
+        XCTAssertEqual(reply.ipv6?.address, "fe80::601:30ff:feb7:ec01")
+        XCTAssertEqual(reply.ipv6?.addressPrefixLength, 64)
+        XCTAssertEqual(reply.ipv6?.defaultGateway, "fe80::601:30ff:feb7:dc02")
         XCTAssertEqual(reply.dnsServers, ["2001:4860:4860::8888", "2001:4860:4860::8844"])
     }
 }