feat: remove and re-add VPN configuration if not working properly

Author: dreymonde

FirewallController.swift

@@ -47,6 +47,16 @@ class FirewallController: NSObject {
             return .invalid
         }
     }
+    
+    func deleteConfigurationAndAddAgain() {
+        refreshManager { (error) in
+            self.manager?.removeFromPreferences(completionHandler: { (removeError) in
+                DispatchQueue.main.asyncAfter(deadline: .now() + 1.0) {
+                    self.setEnabled(true, isUserExplicitToggle: true)
+                }
+            })
+        }
+    }
 
     func restart(completion: @escaping (_ error: Error?) -> Void = {_ in }) {
         // Don't let this affect userWantsFirewallOn/Off config

LockdowniOS/AccountVC.swift

@@ -347,6 +347,13 @@ final class AccountViewController: BaseViewController, Loadable {
         for cell in otherCells {
             tableView.addCell(cell)
         }
+        
+        #if DEBUG
+        let fixVPNConfig = DefaultCell(title: "_Fix Firewall Config", height: buttonHeight, dismissOnTap: true, action: {
+            
+        })
+        tableView.addCell(fixVPNConfig)
+        #endif
     }
 
     func startTutorial() {

LockdowniOS/BaseViewController.swift

@@ -238,6 +238,19 @@ open class BaseViewController: UIViewController, MFMailComposeViewControllerDele
         self.present(popup, animated: true, completion: nil)
     }
 
+    func showFixFirewallConnectionDialog(completion: @escaping () -> ()) {
+        self.showPopupDialog(
+            title: "Tap \"Allow\" on the Next Popup",
+            message: "Due to a recent iOS or Lockdown update, the Firewall needs to be refreshed to run properly.\n\nIf asked, tap \"Allow\" on the next dialog to automatically complete this process.",
+            buttons: [
+                .cancel(),
+                .defaultAccept(completion: {
+                    completion()
+                })
+            ]
+        )
+    }
+    
 //    func showPopupDialogSubmitError(title : String = "Sorry, An Error Occurred", message : String, error: Error?) {
 //        let popup = PopupDialog(title: title, message: message, image: nil, transitionStyle: .zoomIn, hideStatusBar: false)
 //        let acceptButton = DefaultButton(title: "Don't Submit", dismissOnTap: true) { }

LockdowniOS/HomeViewController.swift

@@ -329,7 +329,7 @@ class HomeViewController: BaseViewController, AwesomeSpotlightViewDelegate, Load
     @objc func tunnelStatusDidChange(_ notification: Notification) {
         // Firewall
         if let tunnelProviderSession = notification.object as? NETunnelProviderSession {
-            DDLogInfo("VPNStatusDidChange as NETunnelProviderSession with status: \(tunnelProviderSession.status.rawValue)");
+            DDLogInfo("VPNStatusDidChange as NETunnelProviderSession with status: \(tunnelProviderSession.status.description)");
             if (!getUserWantsFirewallEnabled()) {
                 updateFirewallButtonWithStatus(status: .disconnected)
             }
@@ -346,7 +346,7 @@ class HomeViewController: BaseViewController, AwesomeSpotlightViewDelegate, Load
         }
         // VPN
         else if let neVPNConnection = notification.object as? NEVPNConnection {
-            DDLogInfo("VPNStatusDidChange as NEVPNConnection with status: \(neVPNConnection.status.rawValue)");
+            DDLogInfo("VPNStatusDidChange as NEVPNConnection with status: \(neVPNConnection.status.description)");
             updateVPNButtonWithStatus(status: neVPNConnection.status);
             updateVPNRegionLabel()
             if NEVPNManager.shared().connection.status == .connected || NEVPNManager.shared().connection.status == .disconnected {
@@ -505,9 +505,11 @@ class HomeViewController: BaseViewController, AwesomeSpotlightViewDelegate, Load
         switch FirewallController.shared.status() {
         case .invalid:
             FirewallController.shared.setEnabled(true, isUserExplicitToggle: true)
+            ensureFirewallWorkingAfterEnabling(waitingSeconds: 3.0)
         case .disconnected:
             updateFirewallButtonWithStatus(status: .connecting)
             FirewallController.shared.setEnabled(true, isUserExplicitToggle: true)
+            ensureFirewallWorkingAfterEnabling(waitingSeconds: 3.0)
 
             checkForAskRating()
         case .connected:
@@ -518,6 +520,35 @@ class HomeViewController: BaseViewController, AwesomeSpotlightViewDelegate, Load
         }
     }
 
+    func ensureFirewallWorkingAfterEnabling(waitingSeconds: TimeInterval) {
+        DispatchQueue.main.asyncAfter(deadline: .now() + waitingSeconds) {
+            DDLogInfo("\(waitingSeconds) seconds passed, checking if Firewall is enabled")
+            guard getUserWantsFirewallEnabled() else {
+                // firewall shouldn't be enabled, no need to act
+                DDLogInfo("User doesn't want Firewall enabled, no action")
+                return
+            }
+            
+            let status = FirewallController.shared.status()
+            switch status {
+            case .connecting, .disconnecting, .reasserting:
+                // check again in three seconds
+                DDLogInfo("Firewall is in transient state, will check again in 3 seconds")
+                self.ensureFirewallWorkingAfterEnabling(waitingSeconds: 3.0)
+            case .connected:
+                // all good
+                DDLogInfo("Firewall is connected, no action")
+                break
+            case .disconnected, .invalid:
+                // we suppose that the connection is somehow broken, trying to fix
+                DDLogInfo("Firewall is not connected even though it should be, attempting to fix")
+                self.showFixFirewallConnectionDialog {
+                    FirewallController.shared.deleteConfigurationAndAddAgain()
+                }
+            }
+        }
+    }
+    
     func updateFirewallButtonWithStatus(status: NEVPNStatus) {
         DDLogInfo("UpdateFirewallButton")
         switch status {
@@ -1008,3 +1039,24 @@ final class DynamicButton: PopupDialogButton {
         }
     }
 }
+
+extension NEVPNStatus: CustomStringConvertible {
+    
+    public var description: String {
+        switch self {
+        case .invalid:
+            return "invalid"
+        case .disconnected:
+            return "disconnected"
+        case .connecting:
+            return "connecting"
+        case .connected:
+            return "connected"
+        case .reasserting:
+            return "reasserting"
+        case .disconnecting:
+            return "disconnecting"
+        }
+    }
+    
+}