chore: unified cookie storage - WPB-23404

WireDomain/Sources/WireDomain/Account/AccountManager.swift

@@ -179,7 +179,7 @@ public final class AccountManager: NSObject, Sendable {
 
     public static func delete(at root: URL) {
         AccountStore.delete(directory: AccountURLs(root: root).accounts)
-        UserDefaults.shared().selectedAccountIdentifier = nil
+        UserDefaults.shared()!.selectedAccountIdentifier = nil
     }
 
     // MARK: - Retrieve

WireDomain/Sources/WireDomain/Components/ClientSessionComponent.swift

@@ -20,6 +20,7 @@ import Combine
 import Foundation
 import WireCoreCrypto
 import WireDataModel
+import WireFoundation
 import WireLogging
 import WireNetwork
 
@@ -54,7 +55,7 @@ public final class ClientSessionComponent {
 
     private let isMLSEnabled: Bool
 
-    private let cookieStorage: any CookieStorageProtocol
+    private let cookieStorage: any WireNetwork.CookieStorageProtocol
     private let sharedContainerURL: URL?
     private let sharedUserDefaults: UserDefaults
     private let syncContext: NSManagedObjectContext
@@ -76,7 +77,7 @@ public final class ClientSessionComponent {
         websocketNetworkService: NetworkService,
         backendMetadata: ResolvedBackendMetadata,
         isMLSEnabled: Bool,
-        cookieStorage: any CookieStorageProtocol,
+        cookieStorage: any WireNetwork.CookieStorageProtocol,
         sharedContainerURL: URL?,
         sharedUserDefaults: UserDefaults,
         syncContext: NSManagedObjectContext,
@@ -110,6 +111,7 @@ public final class ClientSessionComponent {
     }
 
     public private(set) lazy var authenticationManager = AuthenticationManager(
+        userID: selfUserID,
         clientID: selfClientID,
         cookieStorage: cookieStorage,
         networkService: restNetworkService,

WireDomain/Sources/WireDomain/Components/UserSessionComponent.swift

@@ -49,7 +49,7 @@ public final class UserSessionComponent {
     public init(
         currentBuildNumber: String,
         selfUserID: UUID,
-        cookieStorage: any CookieStorageProtocol,
+        cookieStorage: any WireNetwork.CookieStorageProtocol,
         restNetworkService: NetworkService,
         websocketNetworkService: NetworkService,
         blacklistNetworkService: NetworkService,
@@ -86,7 +86,7 @@ public final class UserSessionComponent {
         self.faultyMLSRemovalKeysByDomain = faultyMLSRemovalKeysByDomain
     }
 
-    private let cookieStorage: any CookieStorageProtocol
+    private let cookieStorage: any WireNetwork.CookieStorageProtocol
 
     // MARK: - Children
 

WireDomain/Sources/WireDomain/Notifications/Components/NSEClientScope.swift

@@ -208,6 +208,7 @@ final class NSEClientScope: Component<NSEClientScopeDependency> {
     private var authenticationManager: AuthenticationManager {
         shared {
             AuthenticationManager(
+                userID: dependency.accountID,
                 clientID: clientID,
                 cookieStorage: dependency.cookieStorage,
                 networkService: restNetworkService,

WireDomain/Sources/WireDomain/Notifications/Components/NSEUserScope.swift

@@ -77,9 +77,7 @@ final class NSEUserScope: Component<NSEUserScopeDependency> {
     public var cookieStorage: CookieStorage {
         shared {
             CookieStorage(
-                userID: accountID,
-                cookieEncryptionKey: dependency.cookieEncryptionKey,
-                keychain: Keychain()
+                cookieEncryptionKey: dependency.cookieEncryptionKey
             )
         }
     }
@@ -286,7 +284,7 @@ final class NSEUserScope: Component<NSEUserScopeDependency> {
     private func isAuthenticated() async throws -> Bool {
         let cookies: [HTTPCookie]
         do {
-            cookies = try await cookieStorage.fetchCookies()
+            cookies = try cookieStorage.fetchCookies(userID: accountID)
         } catch {
             throw Failure.failedToFetchCookies(error)
         }

WireDomain/Sources/WireDomain/Notifications/VerifyUserSessionUseCase.swift

@@ -17,6 +17,7 @@
 //
 
 import WireDataModel
+import WireFoundation
 import WireLogging
 import WireNetwork
 
@@ -39,16 +40,19 @@ struct VerifyUserSessionUseCase {
 
     // MARK: - Properties
 
+    private let userID: UUID
     private let journal: any JournalProtocol
-    private let cookieStorage: any CookieStorageProtocol
+    private let cookieStorage: any WireNetwork.CookieStorageProtocol
     private let coreData: any CoreDataStackProtocol
     private let logger = WireLogger.notifications
 
     init(
+        userID: UUID,
         journal: any JournalProtocol,
-        cookieStorage: any CookieStorageProtocol,
+        cookieStorage: any WireNetwork.CookieStorageProtocol,
         coreData: any CoreDataStackProtocol
     ) {
+        self.userID = userID
         self.journal = journal
         self.cookieStorage = cookieStorage
         self.coreData = coreData
@@ -74,7 +78,7 @@ struct VerifyUserSessionUseCase {
             attributes: .newNSE
         )
 
-        let cookies = try await cookieStorage.fetchCookies()
+        let cookies = try cookieStorage.fetchCookies(userID: userID)
 
         for cookie in cookies where cookie.name == Constants.cookieName {
             if let cookieExpirationDate = cookie.expiresDate {

WireDomain/Tests/WireDomainTests/Notifications/VerifyUserSessionUseCaseTests.swift

@@ -41,6 +41,7 @@ final class VerifyUserSessionUseCaseTests: XCTestCase {
         cookieStorage = MockCookieStorageProtocol()
 
         sut = VerifyUserSessionUseCase(
+            userID: Scaffolding.userID,
             journal: journal,
             cookieStorage: cookieStorage,
             coreData: stack
@@ -64,13 +65,13 @@ final class VerifyUserSessionUseCaseTests: XCTestCase {
         stack.needsMigration = false
         stack.load_MockMethod = {}
         let validCookie = try XCTUnwrap(Scaffolding.validCookie)
-        cookieStorage.fetchCookies_MockValue = [validCookie]
+        cookieStorage.fetchCookiesUserID_MockValue = [validCookie]
 
         // When
         try await sut.invoke()
 
         // Then
-        XCTAssertEqual(cookieStorage.fetchCookies_Invocations.count, 1)
+        XCTAssertEqual(cookieStorage.fetchCookiesUserID_Invocations.count, 1)
 
     }
 
@@ -90,7 +91,7 @@ final class VerifyUserSessionUseCaseTests: XCTestCase {
     func testVerify_It_Throws_User_Unauthenticated_Error() async throws {
 
         // Mock
-        cookieStorage.fetchCookies_MockValue = [.init()]
+        cookieStorage.fetchCookiesUserID_MockValue = [.init()]
 
         // Then
         await XCTAssertThrowsErrorAsync(VerifyUserSessionUseCase.Failure.userUnauthenticated) { [self] in
@@ -104,7 +105,7 @@ final class VerifyUserSessionUseCaseTests: XCTestCase {
 
         // Mock
         let expiredCookie = try XCTUnwrap(Scaffolding.expiredCookie)
-        cookieStorage.fetchCookies_MockValue = [expiredCookie]
+        cookieStorage.fetchCookiesUserID_MockValue = [expiredCookie]
 
         // Then
         await XCTAssertThrowsErrorAsync(VerifyUserSessionUseCase.Failure.userUnauthenticated) { [self] in
@@ -117,7 +118,7 @@ final class VerifyUserSessionUseCaseTests: XCTestCase {
     func testVerify_It_Throws_User_Unauthenticated_Error_When_No_Cookies_Found() async throws {
 
         // Mock
-        cookieStorage.fetchCookies_MockValue = []
+        cookieStorage.fetchCookiesUserID_MockValue = []
 
         // Then
         await XCTAssertThrowsErrorAsync(VerifyUserSessionUseCase.Failure.userUnauthenticated) { [self] in
@@ -130,7 +131,7 @@ final class VerifyUserSessionUseCaseTests: XCTestCase {
     func testStartSyncingEvents_It_Throws_Core_Data_Missing_Shared_Container() async throws {
         // Mock
         let validCookie = try XCTUnwrap(Scaffolding.validCookie)
-        cookieStorage.fetchCookies_MockValue = [validCookie]
+        cookieStorage.fetchCookiesUserID_MockValue = [validCookie]
         stack.storesExists = false
 
         // Then
@@ -145,7 +146,7 @@ final class VerifyUserSessionUseCaseTests: XCTestCase {
         stack.storesExists = true
         stack.needsMigration = true
         let validCookie = try XCTUnwrap(Scaffolding.validCookie)
-        cookieStorage.fetchCookies_MockValue = [validCookie]
+        cookieStorage.fetchCookiesUserID_MockValue = [validCookie]
 
         // Then
         await XCTAssertThrowsErrorAsync(VerifyUserSessionUseCase.Failure.coreDataMigrationRequired) { [self] in

WireFoundation/Sources/WireFoundation/SDKAbstractions/Keychain.swift

@@ -32,7 +32,7 @@ public struct Keychain: KeychainProtocol {
 
     public func addItem(
         query: Set<KeychainQueryItem>
-    ) async throws {
+    ) throws {
         let status = SecItemAdd(
             query.toCFDictionary(),
             nil
@@ -50,7 +50,7 @@ public struct Keychain: KeychainProtocol {
     public func updateItem(
         query: Set<KeychainQueryItem>,
         attributesToUpdate: Set<KeychainQueryItem>
-    ) async throws {
+    ) throws {
         let status = SecItemUpdate(
             query.toCFDictionary(),
             attributesToUpdate.toCFDictionary()
@@ -67,7 +67,7 @@ public struct Keychain: KeychainProtocol {
 
     public func fetchItem<T>(
         query: Set<KeychainQueryItem>
-    ) async throws -> T? {
+    ) throws -> T? {
         var result: CFTypeRef?
 
         let status = SecItemCopyMatching(
@@ -96,7 +96,7 @@ public struct Keychain: KeychainProtocol {
 
     public func deleteItem(
         query: Set<KeychainQueryItem>
-    ) async throws {
+    ) throws {
         let status = SecItemDelete(
             query.toCFDictionary()
         )
@@ -106,6 +106,27 @@ public struct Keychain: KeychainProtocol {
         }
     }
 
+    /// Delete all items from the keychain.
+
+    public func reset() throws {
+        let items: [KeychainQueryItem] = [
+            .itemClass(.genericPassword),
+            .itemClass(.internetPassword),
+            .itemClass(.certificate),
+            .itemClass(.key),
+            .itemClass(.identity)
+        ]
+
+        for item in items {
+            let query = Set<KeychainQueryItem>([item]).toCFDictionary()
+            let status = SecItemDelete(query)
+            guard status == errSecSuccess || status == errSecItemNotFound else {
+                throw KeychainError.errorStatus(status)
+            }
+
+        }
+    }
+
 }
 
 private extension Set<KeychainQueryItem> {

WireFoundation/Sources/WireFoundation/SDKAbstractions/KeychainProtocol.swift

@@ -23,20 +23,20 @@ public protocol KeychainProtocol: Sendable {
 
     func addItem(
         query: Set<KeychainQueryItem>
-    ) async throws
+    ) throws
 
     func updateItem(
         query: Set<KeychainQueryItem>,
         attributesToUpdate: Set<KeychainQueryItem>
-    ) async throws
+    ) throws
 
     func fetchItem<T>(
         query: Set<KeychainQueryItem>
-    ) async throws -> T?
+    ) throws -> T?
 
     func deleteItem(
         query: Set<KeychainQueryItem>
-    ) async throws
+    ) throws
 
 }
 
@@ -51,14 +51,20 @@ public enum KeychainQueryItem: Hashable, Equatable, Sendable {
 
     case service(String)
     case account(String)
+    case generic(Data)
     case itemClass(ItemClass)
     case accessible(ItemAccessibility)
     case returningData(Bool)
     case data(Data)
+    case returningAttributes(Bool)
 
     public enum ItemClass: Equatable, Sendable {
 
         case genericPassword
+        case internetPassword
+        case certificate
+        case key
+        case identity
 
     }
 
@@ -76,9 +82,24 @@ public enum KeychainQueryItem: Hashable, Equatable, Sendable {
         case let .account(string):
             (kSecAttrAccount, string)
 
+        case let .generic(data):
+            (kSecAttrGeneric, data)
+
         case .itemClass(.genericPassword):
             (kSecClass, kSecClassGenericPassword)
 
+        case .itemClass(.internetPassword):
+            (kSecClass, kSecClassInternetPassword)
+
+        case .itemClass(.certificate):
+            (kSecClass, kSecClassCertificate)
+
+        case .itemClass(.key):
+            (kSecClass, kSecClassKey)
+
+        case .itemClass(.identity):
+            (kSecClass, kSecClassIdentity)
+
         case .accessible(.afterFirstUnlock):
             (kSecAttrAccessible, kSecAttrAccessibleAfterFirstUnlock)
 
@@ -87,6 +108,9 @@ public enum KeychainQueryItem: Hashable, Equatable, Sendable {
 
         case let .data(data):
             (kSecValueData, data)
+
+        case let .returningAttributes(bool):
+            (kSecReturnAttributes, bool)
         }
     }