Add Ability to Delete All Saved Passwords

DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -14,8 +14,7 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/duckduckgo/BrowserServicesKit",
       "state" : {
-        "revision" : "04c35220aa94bd005171086acccadd677400e7d5",
-        "version" : "111.0.2"
+        "revision" : "f087cf8389926b58692870bd5a459bad492ce66d"
       }
     },
     {
@@ -147,7 +146,7 @@
     {
       "identity" : "trackerradarkit",
       "kind" : "remoteSourceControl",
-      "location" : "https://github.com/duckduckgo/TrackerRadarKit.git",
+      "location" : "https://github.com/duckduckgo/TrackerRadarKit",
       "state" : {
         "revision" : "a6b7ba151d9dc6684484f3785293875ec01cc1ff",
         "version" : "1.2.2"

DuckDuckGo/Autofill/AutofillActionBuilder.swift

@@ -0,0 +1,45 @@
+//
+//  AutofillActionBuilder.swift
+//
+//  Copyright © 2024 DuckDuckGo. All rights reserved.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+import BrowserServicesKit
+import Foundation
+
+/// Conforming types provide methods to build an `AutofillActionExecutor` and an `AutofillActionPresenter`
+protocol AutofillActionBuilder {
+    func buildExecutor() -> AutofillActionExecutor?
+    func buildPresenter() -> AutofillActionPresenter
+}
+
+extension AutofillActionBuilder {
+    func buildPresenter() -> AutofillActionPresenter {
+        DefaultAutofillActionPresenter()
+    }
+}
+
+/// Builds an `AutofillActionExecutor`
+struct AutofillDeleteAllPasswordsBuilder: AutofillActionBuilder {
+    @MainActor
+    func buildExecutor() -> AutofillActionExecutor? {
+        guard let secureVault = try? AutofillSecureVaultFactory.makeVault(errorReporter: SecureVaultErrorReporter.shared),
+        let syncService = NSApp.delegateTyped.syncService else { return nil }
+
+        return AutofillDeleteAllPasswordsExecutor(userAuthenticator: DeviceAuthenticator.shared,
+                                                  secureVault: secureVault,
+                                                  syncService: syncService)
+    }
+}

DuckDuckGo/Autofill/AutofillActionExecutor.swift

@@ -0,0 +1,78 @@
+//
+//  AutofillActionExecutor.swift
+//
+//  Copyright © 2024 DuckDuckGo. All rights reserved.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+import Foundation
+import BrowserServicesKit
+import DDGSync
+import AppKit
+
+/// Conforming types provide an `execute` method which performs some action on autofill types (e.g delete all passwords)
+protocol AutofillActionExecutor {
+    init(userAuthenticator: UserAuthenticating, secureVault: any AutofillSecureVault, syncService: DDGSyncing)
+    /// NSAlert to display asking a user to confirm the action
+    var confirmationAlert: NSAlert { get }
+    /// NSAlert to display when the action is complete
+    var completionAlert: NSAlert { get }
+    /// Executes the action
+    func execute(_ onSuccess: (() -> Void)?)
+}
+
+/// Concrete `AutofillActionExecutor` for deletion of all autofill passwords
+struct AutofillDeleteAllPasswordsExecutor: AutofillActionExecutor {
+
+    var confirmationAlert: NSAlert {
+        let accounts = (try? secureVault.accounts()) ?? []
+        return NSAlert.deleteAllPasswordsConfirmationAlert(count: accounts.count, syncEnabled: syncEnabled)
+    }
+
+    var completionAlert: NSAlert {
+        let accounts = (try? secureVault.accounts()) ?? []
+        return NSAlert.deleteAllPasswordsCompletionAlert(count: accounts.count, syncEnabled: syncEnabled)
+    }
+
+    private var syncEnabled: Bool {
+        syncService.authState != .inactive
+    }
+
+    private var userAuthenticator: UserAuthenticating
+    private var secureVault: any AutofillSecureVault
+    private var syncService: DDGSyncing
+
+    init(userAuthenticator: UserAuthenticating, secureVault: any AutofillSecureVault, syncService: DDGSyncing) {
+        self.userAuthenticator = userAuthenticator
+        self.secureVault = secureVault
+        self.syncService = syncService
+    }
+
+    func execute(_ onSuccess: (() -> Void)? = nil) {
+        userAuthenticator.authenticateUser(reason: .deleteAllPasswords) { authenticationResult in
+            guard authenticationResult.authenticated else { return }
+
+            do {
+                try secureVault.deleteAllWebsiteCredentials()
+                syncService.scheduler.notifyDataChanged()
+                NotificationCenter.default.post(name: .PasswordManagerChanged, object: nil)
+                onSuccess?()
+            } catch {
+                Pixel.fire(.debug(event: .secureVaultError, error: error))
+            }
+
+            return
+        }
+    }
+}

DuckDuckGo/Autofill/AutofillActionPresenter.swift

@@ -0,0 +1,62 @@
+//
+//  AutofillActionPresenter.swift
+//
+//  Copyright © 2024 DuckDuckGo. All rights reserved.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+import Foundation
+import AppKit
+
+/// Conforming types handles presentation of `NSAlert`s associated with an `AutofillActionExecutor`
+protocol AutofillActionPresenter {
+    func show(actionExecutor: AutofillActionExecutor)
+}
+
+/// Handles presentation of an alert associated with an `AutofillActionExecutor`
+struct DefaultAutofillActionPresenter: AutofillActionPresenter {
+
+    @MainActor
+    func show(actionExecutor: AutofillActionExecutor) {
+        guard let window else { return }
+
+        let confirmationAlert = actionExecutor.confirmationAlert
+        let completionAlert = actionExecutor.completionAlert
+
+        confirmationAlert.beginSheetModal(for: window) { response in
+            switch response {
+            case .alertFirstButtonReturn:
+                actionExecutor.execute {
+                    show(completionAlert)
+                }
+            default:
+                break
+            }
+        }
+    }
+}
+
+private extension DefaultAutofillActionPresenter {
+
+    @MainActor
+    func show(_ alert: NSAlert) {
+        guard let window else { return }
+        alert.beginSheetModal(for: window)
+    }
+
+    @MainActor
+    var window: NSWindow? {
+        WindowControllersManager.shared.lastKeyMainWindowController?.window
+    }
+}

DuckDuckGo/Common/Extensions/NSAlertExtension.swift

@@ -255,6 +255,41 @@ extension NSAlert {
         return alert
     }
 
+    static func deleteAllPasswordsConfirmationAlert(count: Int, syncEnabled: Bool) -> NSAlert {
+        let messageText = UserText.deleteAllPasswordsConfirmationMessageText(count: count)
+        let informationText = UserText.deleteAllPasswordsConfirmationInformationText(count: count, syncEnabled: syncEnabled)
+        return autofillActionConfirmationAlert(messageText: messageText,
+                                        informationText: informationText,
+                                        confirmButtonText: UserText.passwordManagerAlerDeleteButton)
+    }
+
+    private static func autofillActionConfirmationAlert(messageText: String,
+                                                        informationText: String,
+                                                        confirmButtonText: String) -> NSAlert {
+        let alert = NSAlert()
+        alert.messageText = messageText
+        alert.informativeText = informationText
+        alert.alertStyle = .warning
+        alert.addButton(withTitle: confirmButtonText)
+        alert.addButton(withTitle: UserText.cancel)
+        return alert
+    }
+
+    static func deleteAllPasswordsCompletionAlert(count: Int, syncEnabled: Bool) -> NSAlert {
+        let messageText = UserText.deleteAllPasswordsCompletionMessageText(count: count)
+        let informationText = UserText.deleteAllPasswordsCompletionInformationText(count: count, syncEnabled: syncEnabled)
+        return autofillActionCompletionAlert(messageText: messageText,
+                                      informationText: informationText)
+    }
+
+    private static func autofillActionCompletionAlert(messageText: String, informationText: String) -> NSAlert {
+        let alert = NSAlert()
+        alert.messageText = messageText
+        alert.informativeText = informationText
+        alert.addButton(withTitle: UserText.ok)
+        return alert
+    }
+
     @discardableResult
     func runModal() async -> NSApplication.ModalResponse {
         await withCheckedContinuation { continuation in

DuckDuckGo/Common/Localizables/UserText.swift

@@ -1059,6 +1059,63 @@ struct UserText {
         }
     }
 
+    // MARK: Autofill Item Deletion (Autofill -> More Menu, Settings -> Autofill)
+    static let deleteAllPasswords = NSLocalizedString("autofill.items.delete-all-passwords", value: "Delete All Passwords…", comment: "Opens Delete All Passwords dialog")
+
+    // Confirmation Message Text
+    static func deleteAllPasswordsConfirmationMessageText(count: Int) -> String {
+        let localized = NSLocalizedString("autofill.items.delete-all-passwords-confirmation-message-text", value: "Are you sure you want to delete all passwords (%d)?", comment: "Message displayed on dialog asking user to confirm deletion of all passwords")
+        return String(format: localized, count)
+    }
+
+    // Confirmation Information Text
+    static func deleteAllPasswordsConfirmationInformationText(count: Int, syncEnabled: Bool) -> String {
+        switch(count, syncEnabled) {
+        case (1, true):
+            return NSLocalizedString("autofill.items.delete-one-password-synced-confirmation-information-text", value: "Your password will be deleted from all synced devices. Make sure you still have a way to access your accounts.", comment: "Information message displayed when deleting one password on a synced device")
+        case (1, false):
+            return NSLocalizedString("autofill.items.delete-one-password-device-confirmation-information-text", value: "Your password will be deleted from this device.", comment: "Information message displayed when deleting one password on a device")
+        case (_, true):
+            return NSLocalizedString("autofill.items.delete-all-passwords-synced-confirmation-information-text", value: "Your passwords will be deleted from all synced devices. Make sure you still have a way to access your accounts.", comment: "Information message displayed when deleting all passwords on a synced device")
+        default:
+            return NSLocalizedString("autofill.items.delete-all-passwords-device-confirmation-information-text", value: "Your passwords will be deleted from this device.", comment: "Information message displayed when deleting all passwords on a device")
+        }
+    }
+
+    // Completion Message Text
+    static func deleteAllPasswordsCompletionMessageText(count: Int) -> String {
+        if count == 1 {
+            return NSLocalizedString("autofill.items.delete-one-password-confirmation-message-text", value: "Password deleted", comment: "Message displayed on completion of single password deletion")
+        } else {
+            let localized = NSLocalizedString("autofill.items.delete-all-passwords-confirmation-message-text", value: "Passwords deleted (%d)", comment: "Message displayed on completion of multiple password deletion")
+            return String(format: localized, count)
+        }
+    }
+
+    // Completion Information Text
+    static func deleteAllPasswordsCompletionInformationText(count: Int, syncEnabled: Bool) -> String {
+        switch(count, syncEnabled) {
+        case (1, true):
+            return NSLocalizedString("autofill.items.delete-one-password-synced-completion-information-text",
+                                                                                   value: "Your password have been deleted from all synced devices.",
+                                                                                   comment: "Information message displayed on completion of single password deletion when devices are synced")
+        case (1, false):
+            return NSLocalizedString("autofill.items.delete-one-password-device-completion-information-text",
+                                                                                   value: "Your password have been deleted from this device.",
+                                                                                   comment: "Information message displayed on completion of single password deletion when devices are not synced")
+        case (_, true):
+            return NSLocalizedString("autofill.items.delete-all-passwords-synced-completion-information-text",
+                                                                                   value: "Your passwords have been deleted from all synced devices.",
+                                                                                   comment: "Information message displayed on completion of multiple password deletion when devices are synced")
+        default:
+            return NSLocalizedString("autofill.items.delete-all-passwords-device-completion-information-text",
+                                                                                   value: "Your passwords have been deleted from this device.",
+                                                                                   comment: "Information message displayed on completion of multiple password deletion when no devices are not synced")
+        }
+    }
+
+    static let deleteAllPasswordsPermissionText = NSLocalizedString("autofill.items.delete-all-passwords-permisson-text", value: "Authenticate to confirm you want to delete all passwords", comment: "Message displayed in system authentication dialog")
+
 #if SUBSCRIPTION
     // Key: "subscription.menu.item"
     // Comment: "Title for Subscription item in the options menu"

DuckDuckGo/DeviceAuthentication/DeviceAuthenticator.swift

@@ -40,6 +40,7 @@ final class DeviceAuthenticator: UserAuthenticating {
         case unlockLogins
         case exportLogins
         case syncSettings
+        case deleteAllPasswords
 
         var localizedDescription: String {
             switch self {
@@ -48,6 +49,7 @@ final class DeviceAuthenticator: UserAuthenticating {
             case .unlockLogins: return UserText.pmAutoLockPromptUnlockLogins
             case .exportLogins: return UserText.pmAutoLockPromptExportLogins
             case .syncSettings: return UserText.syncAutoLockPrompt
+            case .deleteAllPasswords: return UserText.deleteAllPasswordsPermissionText
             }
         }
     }
@@ -154,7 +156,8 @@ final class DeviceAuthenticator: UserAuthenticating {
     func authenticateUser(reason: AuthenticationReason, result: @escaping (DeviceAuthenticationResult) -> Void) {
         let needsAuthenticationForCreditCardsAutofill = reason == .autofillCreditCards && isCreditCardTimeIntervalExpired()
         let needsAuthenticationForSyncSettings = reason == .syncSettings && isSyncSettingsTimeIntervalExpired()
-        guard needsAuthenticationForCreditCardsAutofill || needsAuthenticationForSyncSettings || requiresAuthentication else {
+        let needsAuthenticationForDeleteAllPasswords = reason == .deleteAllPasswords
+        guard needsAuthenticationForCreditCardsAutofill || needsAuthenticationForSyncSettings || needsAuthenticationForDeleteAllPasswords || requiresAuthentication else {
             result(.success)
             return
         }