Siri Shortcuts integration for iOS

Sources/WireGuardApp/Tunnel/TunnelsManager.swift

@@ -5,6 +5,10 @@ import Foundation
 import NetworkExtension
 import os.log
 
+#if os(iOS)
+import Intents
+#endif
+
 protocol TunnelsManagerListDelegate: AnyObject {
     func tunnelAdded(at index: Int)
     func tunnelModified(at index: Int)
@@ -307,6 +311,12 @@ class TunnelsManager {
         }
         #elseif os(iOS)
         (tunnelProviderManager.protocolConfiguration as? NETunnelProviderProtocol)?.destroyConfigurationReference()
+
+        INInteraction.delete(with: "com.wireguard.intents.tunnel.\(tunnel.name)") { error in
+            if let error = error {
+                wg_log(.error, message: "Error deleting donated interactions for tunnel \(tunnel.name): \(error.localizedDescription)")
+            }
+        }
         #else
         #error("Unimplemented")
         #endif

Sources/WireGuardApp/UI/iOS/AppDelegate.swift

@@ -3,6 +3,7 @@
 
 import UIKit
 import os.log
+import Intents
 
 @UIApplicationMain
 class AppDelegate: UIResponder, UIApplicationDelegate {
@@ -11,6 +12,10 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     var mainVC: MainViewController?
     var isLaunchedForSpecificAction = false
 
+    var tunnelsManager: TunnelsManager?
+
+    static let tunnelsManagerReadyNotificationName: Notification.Name = Notification.Name(rawValue: "com.wireguard.ios.tunnelsManagerReadyNotification")
+
     func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
         Logger.configureGlobal(tagged: "APP", withFilePath: FileManager.logFileURL?.path)
 
@@ -29,6 +34,25 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 
         self.mainVC = mainVC
 
+        // Create the tunnels manager, and when it's ready, inform tunnelsListVC
+        TunnelsManager.create { [weak self] result in
+            guard let self = self else { return }
+
+            switch result {
+            case .failure(let error):
+                ErrorPresenter.showErrorAlert(error: error, from: self.mainVC)
+            case .success(let tunnelsManager):
+                self.tunnelsManager = tunnelsManager
+                self.mainVC?.tunnelsListVC?.setTunnelsManager(tunnelsManager: tunnelsManager)
+
+                tunnelsManager.activationDelegate = self.mainVC
+
+                NotificationCenter.default.post(name: AppDelegate.tunnelsManagerReadyNotificationName,
+                                                object: self,
+                                                userInfo: nil)
+            }
+        }
+
         return true
     }
 
@@ -82,3 +106,92 @@ extension AppDelegate {
         return nil
     }
 }
+
+extension AppDelegate {
+
+    func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
+
+        guard let interaction = userActivity.interaction else {
+            return false
+        }
+
+        if interaction.intent is UpdateConfigurationIntent {
+            if let tunnelsManager = tunnelsManager {
+                self.handleupdateConfigurationIntent(interaction: interaction, tunnelsManager: tunnelsManager)
+            } else {
+                var token: NSObjectProtocol?
+                token = NotificationCenter.default.addObserver(forName: AppDelegate.tunnelsManagerReadyNotificationName, object: nil, queue: .main) { [weak self] _ in
+                    guard let tunnelsManager = self?.tunnelsManager else { return }
+
+                    self?.handleupdateConfigurationIntent(interaction: interaction, tunnelsManager: tunnelsManager)
+                    NotificationCenter.default.removeObserver(token!)
+                }
+            }
+
+            return true
+        }
+
+        return false
+    }
+
+    func handleupdateConfigurationIntent(interaction: INInteraction, tunnelsManager: TunnelsManager) {
+
+        guard let updateConfigurationIntent = interaction.intent as? UpdateConfigurationIntent,
+              let configurationUpdates = interaction.intentResponse?.userActivity?.userInfo else {
+            return
+        }
+
+        guard let tunnelName = updateConfigurationIntent.tunnel,
+              let configurations = configurationUpdates["Configuration"] as? [String: [String: String]] else {
+                  wg_log(.error, message: "Failed to get informations to update the configuration")
+                  return
+        }
+
+        guard let tunnel = tunnelsManager.tunnel(named: tunnelName),
+              let tunnelConfiguration = tunnel.tunnelConfiguration else {
+                  wg_log(.error, message: "Failed to get tunnel configuration with name \(tunnelName)")
+                  ErrorPresenter.showErrorAlert(title: "Tunnel not found",
+                                                message: "Tunnel with name '\(tunnelName)' is not present.",
+                                                from: self.mainVC)
+                  return
+        }
+
+        var peers = tunnelConfiguration.peers
+
+        for (peerPubKey, valuesToUpdate) in configurations {
+            guard let peerIndex = peers.firstIndex(where: { $0.publicKey.base64Key == peerPubKey }) else {
+                wg_log(.debug, message: "Failed to find peer \(peerPubKey) in tunnel with name \(tunnelName)")
+                ErrorPresenter.showErrorAlert(title: "Peer not found",
+                                              message: "Peer '\(peerPubKey)' is not present in '\(tunnelName)' tunnel.",
+                                              from: self.mainVC)
+                continue
+            }
+
+            if let endpointString = valuesToUpdate["Endpoint"] {
+                if let newEntpoint = Endpoint(from: endpointString) {
+                    peers[peerIndex].endpoint = newEntpoint
+                } else {
+                    wg_log(.debug, message: "Failed to convert \(endpointString) to Endpoint")
+                }
+            }
+        }
+
+        let newConfiguration = TunnelConfiguration(name: tunnel.name, interface: tunnelConfiguration.interface, peers: peers)
+
+        tunnelsManager.modify(tunnel: tunnel, tunnelConfiguration: newConfiguration, onDemandOption: tunnel.onDemandOption) { error in
+            guard error == nil else {
+                wg_log(.error, message: error!.localizedDescription)
+                ErrorPresenter.showErrorAlert(error: error!, from: self.mainVC)
+                return
+            }
+
+            if let completionUrlString = updateConfigurationIntent.completionUrl,
+                !completionUrlString.isEmpty,
+                let completionUrl = URL(string: completionUrlString) {
+                UIApplication.shared.open(completionUrl, options: [:], completionHandler: nil)
+            }
+
+            wg_log(.debug, message: "Updated configuration of tunnel \(tunnelName)")
+        }
+    }
+}

Sources/WireGuardApp/UI/iOS/Info.plist

@@ -2,10 +2,10 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-	<key>ITSAppUsesNonExemptEncryption</key>
-	<false/>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleDisplayName</key>
+	<string>$(PRODUCT_NAME)</string>
 	<key>CFBundleDocumentTypes</key>
 	<array>
 		<dict>
@@ -64,8 +64,6 @@
 	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
-	<key>CFBundleDisplayName</key>
-	<string>$(PRODUCT_NAME)</string>
 	<key>CFBundleName</key>
 	<string>$(PRODUCT_NAME)</string>
 	<key>CFBundlePackageType</key>
@@ -74,17 +72,24 @@
 	<string>$(VERSION_NAME)</string>
 	<key>CFBundleVersion</key>
 	<string>$(VERSION_ID)</string>
+	<key>ITSAppUsesNonExemptEncryption</key>
+	<false/>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
 	<key>LSSupportsOpeningDocumentsInPlace</key>
 	<false/>
 	<key>NSCameraUsageDescription</key>
 	<string>Localized</string>
+	<key>NSFaceIDUsageDescription</key>
+	<string>Localized</string>
+	<key>NSUserActivityTypes</key>
+	<array>
+		<string>UpdateConfigurationIntent</string>
+	</array>
 	<key>UILaunchStoryboardName</key>
 	<string>LaunchScreen</string>
 	<key>UIRequiredDeviceCapabilities</key>
-	<array>
-	</array>
+	<array/>
 	<key>UISupportedInterfaceOrientations</key>
 	<array>
 		<string>UIInterfaceOrientationPortrait</string>
@@ -123,8 +128,6 @@
 			</dict>
 		</dict>
 	</array>
-	<key>NSFaceIDUsageDescription</key>
-	<string>Localized</string>
 	<key>com.wireguard.ios.app_group_id</key>
 	<string>group.$(APP_ID_IOS)</string>
 </dict>

Sources/WireGuardApp/UI/iOS/ViewController/MainViewController.swift

@@ -2,10 +2,13 @@
 // Copyright © 2018-2021 WireGuard LLC. All Rights Reserved.
 
 import UIKit
+import Intents
 
 class MainViewController: UISplitViewController {
 
-    var tunnelsManager: TunnelsManager?
+    var tunnelsManager: TunnelsManager? {
+        return (UIApplication.shared.delegate as? AppDelegate)?.tunnelsManager
+    }
     var onTunnelsManagerReady: ((TunnelsManager) -> Void)?
     var tunnelsListVC: TunnelsListTableViewController?
 
@@ -42,29 +45,24 @@ class MainViewController: UISplitViewController {
         // On iPad, always show both masterVC and detailVC, even in portrait mode, like the Settings app
         preferredDisplayMode = .allVisible
 
-        // Create the tunnels manager, and when it's ready, inform tunnelsListVC
-        TunnelsManager.create { [weak self] result in
-            guard let self = self else { return }
-
-            switch result {
-            case .failure(let error):
-                ErrorPresenter.showErrorAlert(error: error, from: self)
-            case .success(let tunnelsManager):
-                self.tunnelsManager = tunnelsManager
-                self.tunnelsListVC?.setTunnelsManager(tunnelsManager: tunnelsManager)
-
-                tunnelsManager.activationDelegate = self
-
-                self.onTunnelsManagerReady?(tunnelsManager)
-                self.onTunnelsManagerReady = nil
-            }
-        }
+        NotificationCenter.default.addObserver(self, selector: #selector(handleTunnelsManagerReady(_:)),
+                                               name: AppDelegate.tunnelsManagerReadyNotificationName, object: nil)
     }
 
     func allTunnelNames() -> [String]? {
         guard let tunnelsManager = self.tunnelsManager else { return nil }
         return tunnelsManager.mapTunnels { $0.name }
     }
+
+    @objc
+    func handleTunnelsManagerReady(_ notification: Notification) {
+        guard let tunnelsManager = self.tunnelsManager else { return }
+
+        self.onTunnelsManagerReady?(tunnelsManager)
+        self.onTunnelsManagerReady = nil
+
+        NotificationCenter.default.removeObserver(self, name: AppDelegate.tunnelsManagerReadyNotificationName, object: nil)
+    }
 }
 
 extension MainViewController: TunnelsManagerActivationDelegate {
@@ -99,10 +97,25 @@ extension MainViewController {
             if let tunnel = tunnelsManager.tunnel(named: tunnelName) {
                 tunnelsListVC.showTunnelDetail(for: tunnel, animated: false)
                 if shouldToggleStatus {
+
+                    let intent = SetTunnelStatusIntent()
+                    intent.tunnel = tunnel.name
+                    intent.operation = .turn
+
                     if tunnel.status == .inactive {
                         tunnelsManager.startActivation(of: tunnel)
+                        intent.state = .on
                     } else if tunnel.status == .active {
                         tunnelsManager.startDeactivation(of: tunnel)
+                        intent.state = .off
+                    }
+
+                    let interaction = INInteraction(intent: intent, response: nil)
+                    interaction.groupIdentifier = "com.wireguard.intents.tunnel.\(tunnel.name)"
+                    interaction.donate { error in
+                        if let  error = error {
+                            wg_log(.error, message: "Error donating interaction for SetTunnelStatusIntent: \(error.localizedDescription)")
+                        }
                     }
                 }
             }

Sources/WireGuardApp/UI/iOS/ViewController/TunnelDetailTableViewController.swift

@@ -2,6 +2,7 @@
 // Copyright © 2018-2021 WireGuard LLC. All Rights Reserved.
 
 import UIKit
+import Intents
 
 class TunnelDetailTableViewController: UITableViewController {
 
@@ -387,6 +388,18 @@ extension TunnelDetailTableViewController {
         cell.onSwitchToggled = { [weak self] isOn in
             guard let self = self else { return }
 
+            let intent = SetTunnelStatusIntent()
+            intent.tunnel = self.tunnel.name
+            intent.operation = .turn
+            intent.state = isOn ? .on : .off
+            let interaction = INInteraction(intent: intent, response: nil)
+            interaction.groupIdentifier = "com.wireguard.intents.tunnel.\(self.tunnel.name)"
+            interaction.donate { error in
+                if let  error = error {
+                    wg_log(.error, message: "Error donating interaction for SetTunnelStatusIntent: \(error.localizedDescription)")
+                }
+            }
+
             if self.tunnel.hasOnDemandRules {
                 self.tunnelsManager.setOnDemandEnabled(isOn, on: self.tunnel) { error in
                     if error == nil && !isOn {

Sources/WireGuardApp/UI/iOS/ViewController/TunnelsListTableViewController.swift

@@ -4,6 +4,7 @@
 import UIKit
 import MobileCoreServices
 import UserNotifications
+import Intents
 
 class TunnelsListTableViewController: UIViewController {
 
@@ -317,6 +318,19 @@ extension TunnelsListTableViewController: UITableViewDataSource {
             cell.tunnel = tunnel
             cell.onSwitchToggled = { [weak self] isOn in
                 guard let self = self, let tunnelsManager = self.tunnelsManager else { return }
+
+                let intent = SetTunnelStatusIntent()
+                intent.tunnel = tunnel.name
+                intent.operation = .turn
+                intent.state = isOn ? .on : .off
+                let interaction = INInteraction(intent: intent, response: nil)
+                interaction.groupIdentifier = "com.wireguard.intents.tunnel.\(tunnel.name)"
+                interaction.donate { error in
+                    if let  error = error {
+                        wg_log(.error, message: "Error donating interaction for SetTunnelStatusIntent: \(error.localizedDescription)")
+                    }
+                }
+
                 if tunnel.hasOnDemandRules {
                     tunnelsManager.setOnDemandEnabled(isOn, on: tunnel) { error in
                         if error == nil && !isOn {

Sources/WireGuardApp/UI/iOS/WireGuard.entitlements

@@ -8,6 +8,8 @@
 	</array>
 	<key>com.apple.developer.networking.wifi-info</key>
 	<true/>
+	<key>com.apple.developer.siri</key>
+	<true/>
 	<key>com.apple.security.application-groups</key>
 	<array>
 		<string>group.$(APP_ID_IOS)</string>