VPN-5681 - remove iOS VPN profile when logging out or resetting

src/connectionmanager.cpp

@@ -256,6 +256,12 @@ void ConnectionManager::quit() {
   }
 }
 
+void ConnectionManager::deleteOSTunnelConfig() {
+  if (m_impl) {
+    m_impl->deleteOSTunnelConfig();
+  }
+}
+
 void ConnectionManager::handshakeTimeout() {
   logger.debug() << "Timeout while waiting for handshake";
 

src/connectionmanager.h

@@ -77,6 +77,7 @@ class ConnectionManager : public QObject, public LogSerializer {
   bool switchServers(const ServerData& serverData);
   void backendFailure();
   void updateRequired();
+  void deleteOSTunnelConfig();
 
   const ServerData& currentServer() const { return m_serverData; }
 

src/controllerimpl.h

@@ -46,6 +46,11 @@ class ControllerImpl : public QObject {
   // "disconnecting" state until the "disconnected" signal is received.
   virtual void deactivate(ConnectionManager::Reason reason) = 0;
 
+  // This method is used to remove the tunnel config from the operating
+  // system. This is used upon logging out and resetting, so the
+  // tunnel cannot be reactivated in system settings.
+  virtual void deleteOSTunnelConfig(){};
+
   // This method is used to retrieve the VPN tunnel status (mainly the number
   // of bytes sent and received). It's called always when the VPN tunnel is
   // active.

src/mozillavpn.cpp

@@ -834,6 +834,8 @@ void MozillaVPN::logout() {
     ProductsHandler::instance()->stopProductsRegistration();
   }
 
+  connectionManager()->deleteOSTunnelConfig();
+
   // update-required state is the only one we want to keep when logging out.
   if (state() != StateUpdateRequired) {
     setState(StateInitialize);
@@ -1292,6 +1294,7 @@ void MozillaVPN::hardReset() {
   SettingsHolder* settingsHolder = SettingsHolder::instance();
   Q_ASSERT(settingsHolder);
   settingsHolder->hardReset();
+  connectionManager()->deleteOSTunnelConfig();
 }
 
 void MozillaVPN::hardResetAndQuit() {

src/platforms/ios/ioscontroller.h

@@ -23,6 +23,8 @@ class IOSController final : public ControllerImpl {
 
   void deactivate(ConnectionManager::Reason reason) override;
 
+  void deleteOSTunnelConfig() override;
+
   void checkStatus() override;
 
   void getBackendLogs(std::function<void(const QString&)>&& callback) override;

src/platforms/ios/ioscontroller.mm

@@ -142,25 +142,25 @@
   Q_ASSERT(settingsHolder);
 
   [impl connectWithDnsServer:config.m_dnsServer.toNSString()
-               serverIpv6Gateway:config.m_serverIpv6Gateway.toNSString()
-                 serverPublicKey:config.m_serverPublicKey.toNSString()
-                serverIpv4AddrIn:config.m_serverIpv4AddrIn.toNSString()
-                      serverPort:config.m_serverPort
-          allowedIPAddressRanges:allowedIPAddressRangesNS
-                          reason:reason
-                   gleanDebugTag:settingsHolder->gleanDebugTagActive()
-                                     ? settingsHolder->gleanDebugTag().toNSString()
-                                     : @""
+      serverIpv6Gateway:config.m_serverIpv6Gateway.toNSString()
+      serverPublicKey:config.m_serverPublicKey.toNSString()
+      serverIpv4AddrIn:config.m_serverIpv4AddrIn.toNSString()
+      serverPort:config.m_serverPort
+      allowedIPAddressRanges:allowedIPAddressRangesNS
+      reason:reason
+      gleanDebugTag:settingsHolder->gleanDebugTagActive()
+                        ? settingsHolder->gleanDebugTag().toNSString()
+                        : @""
       isSuperDooperFeatureActive:Feature::get(Feature::Feature_superDooperMetrics)->isSupported()
-                  installationId:config.m_installationId.toNSString()
-                  isOnboarding:MozillaVPN::instance()->state() == App::StateOnboarding
-                 disconnectCallback:^() {
-                   logger.error() << "IOSSWiftController - disconnecting";
-                   emit disconnected();
-                 }
-                onboardingCompletedCallback:^() {
-                    MozillaVPN::instance()->onboardingCompleted();
-                 }];
+      installationId:config.m_installationId.toNSString()
+      isOnboarding:MozillaVPN::instance()->state() == App::StateOnboarding
+      disconnectCallback:^() {
+        logger.error() << "IOSSWiftController - disconnecting";
+        emit disconnected();
+      }
+      onboardingCompletedCallback:^() {
+        MozillaVPN::instance()->onboardingCompleted();
+      }];
 }
 
 void IOSController::deactivate(ConnectionManager::Reason reason) {
@@ -181,6 +181,8 @@
   [impl disconnect];
 }
 
+void IOSController::deleteOSTunnelConfig() { [impl deleteOSTunnelConfig]; }
+
 void IOSController::checkStatus() {
   logger.debug() << "Checking status";
 

src/platforms/ios/ioscontroller.swift

@@ -119,7 +119,7 @@ public class IOSControllerImpl : NSObject {
     @objc func connect(dnsServer: String, serverIpv6Gateway: String, serverPublicKey: String, serverIpv4AddrIn: String, serverPort: Int,  allowedIPAddressRanges: Array<VPNIPAddressRange>, reason: Int, gleanDebugTag: String, isSuperDooperFeatureActive: Bool, installationId: String, isOnboarding: Bool, disconnectCallback: @escaping () -> Void, onboardingCompletedCallback: @escaping () -> Void) {
         IOSControllerImpl.logger.debug(message: "Connecting")
 
-        let _ = TunnelManager.withTunnel { tunnel in
+        TunnelManager.withTunnel { tunnel in
             // Let's remove the previous config if it exists.
             (tunnel.protocolConfiguration as? NETunnelProviderProtocol)?.destroyConfigurationReference()
 
@@ -157,7 +157,7 @@ public class IOSControllerImpl : NSObject {
     }
 
     func configureTunnel(config: TunnelConfiguration, reason: Int, serverName: String, gleanDebugTag: String, isSuperDooperFeatureActive: Bool, installationId: String, isOnboarding: Bool, disconnectCallback: @escaping () -> Void, onboardingCompletedCallback: @escaping () -> Void) {
-        let _ = TunnelManager.withTunnel { tunnel in
+        TunnelManager.withTunnel { tunnel in
             let proto = NETunnelProviderProtocol(tunnelConfiguration: config)
             proto!.providerBundleIdentifier = TunnelManager.vpnBundleId
             proto!.disconnectOnSleep = false
@@ -238,10 +238,21 @@ public class IOSControllerImpl : NSObject {
         TunnelManager.session?.stopTunnel()
     }
 
+    @objc func deleteOSTunnelConfig() {
+      IOSControllerImpl.logger.info(message: "Removing tunnel from iOS System Preferences")
+      TunnelManager.withTunnel { tunnel in
+        tunnel.removeFromPreferences(completionHandler: { error in
+          if let error = error {
+            IOSControllerImpl.logger.info(message: "Error when removing tunnel \(error.localizedDescription)")
+          }
+        })
+      }
+    }
+
     @objc func checkStatus(callback: @escaping (String, String, String) -> Void) {
         IOSControllerImpl.logger.info(message: "Check status")
 
-        let _ = TunnelManager.withTunnel { tunnel in
+        TunnelManager.withTunnel { tunnel in
             let proto = tunnel.protocolConfiguration as? NETunnelProviderProtocol
             if proto == nil {
                 callback("", "", "")

src/platforms/ios/iostunnelmanager.swift

@@ -47,7 +47,7 @@ class TunnelManager {
         }
     }
 
-    static func withTunnel(_ f: (_ tunnel: NETunnelProviderManager) throws -> Any) -> Any? {
+    @discardableResult static func withTunnel(_ f: (_ tunnel: NETunnelProviderManager) throws -> Any) -> Any? {
         guard let tunnel = TunnelManager.instance.tunnel else {
             logger.error(message: "Attempted to use the VPN tunnel, but it's not available.")
             return nil