Subscription oauth api v2

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

@@ -32,8 +32,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/duckduckgo/BrowserServicesKit",
       "state" : {
-        "revision" : "9d802fef9b1704adad1675ce5656843202d1f28e",
-        "version" : "224.3.0"
+        "branch" : "fcappelli/subscription_oauth_api_v2",
+        "revision" : "f365a42528ec48448715820bc337d2f079fa2a52"
       }
     },
     {
@@ -72,6 +72,15 @@
         "version" : "6.0.1"
       }
     },
+    {
+      "identity" : "jwt-kit",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/vapor/jwt-kit.git",
+      "state" : {
+        "revision" : "c2595b9ad7f512d7f334830b4df1fed6e917946a",
+        "version" : "4.13.4"
+      }
+    },
     {
       "identity" : "lottie-spm",
       "kind" : "remoteSourceControl",
@@ -135,6 +144,24 @@
         "version" : "1.4.0"
       }
     },
+    {
+      "identity" : "swift-asn1",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-asn1.git",
+      "state" : {
+        "revision" : "ae33e5941bb88d88538d0a6b19ca0b01e6c76dcf",
+        "version" : "1.3.1"
+      }
+    },
+    {
+      "identity" : "swift-crypto",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-crypto.git",
+      "state" : {
+        "revision" : "ff0f781cf7c6a22d52957e50b104f5768b50c779",
+        "version" : "3.10.0"
+      }
+    },
     {
       "identity" : "swift-snapshot-testing",
       "kind" : "remoteSourceControl",

DuckDuckGo.xcodeproj/xcshareddata/xcschemes/Unit Tests.xcscheme

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1620"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES"
+      buildArchitectures = "Automatic">
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "AA585D8F248FD31400E9A3E2"
+               BuildableName = "Unit Tests.xctest"
+               BlueprintName = "Unit Tests"
+               ReferencedContainer = "container:DuckDuckGo.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "AA585D7D248FD31100E9A3E2"
+            BuildableName = "DuckDuckGo.app"
+            BlueprintName = "DuckDuckGo Privacy Browser"
+            ReferencedContainer = "container:DuckDuckGo.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

DuckDuckGo/Application/AppDelegate.swift

@@ -107,7 +107,7 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
     let remoteMessagingClient: RemoteMessagingClient!
     let onboardingStateMachine: ContextualOnboardingStateMachine & ContextualOnboardingStateUpdater
 
-    public let subscriptionManager: SubscriptionManager
+    public let subscriptionManager: any SubscriptionManager
     public let subscriptionUIHandler: SubscriptionUIHandling
     private let subscriptionCookieManager: SubscriptionCookieManaging
     private var subscriptionCookieManagerFeatureFlagCancellable: AnyCancellable?
@@ -133,9 +133,10 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
     // MARK: - DBP
 
     private lazy var dataBrokerProtectionSubscriptionEventHandler: DataBrokerProtectionSubscriptionEventHandler = {
-        let authManager = DataBrokerAuthenticationManagerBuilder.buildAuthenticationManager(subscriptionManager: subscriptionManager)
+        let authenticationManager = DataBrokerProtectionAuthenticationManager(
+            subscriptionManager: subscriptionManager)
         return DataBrokerProtectionSubscriptionEventHandler(featureDisabler: DataBrokerProtectionFeatureDisabler(),
-                                                            authenticationManager: authManager,
+                                                            authenticationManager: authenticationManager,
                                                             pixelHandler: DataBrokerProtectionPixelsHandler())
     }()
 
@@ -152,7 +153,7 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
         )
 
         return VPNRedditSessionWorkaround(
-            accountManager: subscriptionManager.accountManager,
+            subscriptionManager: subscriptionManager,
             ipcClient: ipcClient,
             statusReporter: statusReporter
         )
@@ -292,8 +293,16 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
 
         onboardingStateMachine = ContextualOnboardingStateMachine()
 
-        // Configure Subscription
-        subscriptionManager = DefaultSubscriptionManager(featureFlagger: featureFlagger)
+        // MARK: - Subscription configuration
+        let subscriptionAppGroup = Bundle.main.appGroup(bundle: .subs)
+        let subscriptionUserDefaults = UserDefaults(suiteName: subscriptionAppGroup)!
+        let subscriptionEnvironment = DefaultSubscriptionManager.getSavedOrDefaultEnvironment(userDefaults: subscriptionUserDefaults)
+        subscriptionManager = DefaultSubscriptionManager(keychainType: .dataProtection(.named(subscriptionAppGroup)),
+                                                         environment: subscriptionEnvironment,
+                                                         userDefaults: subscriptionUserDefaults,
+                                                         canPerformAuthMigration: true,
+                                                         canHandlePixels: true)
+
         subscriptionUIHandler = SubscriptionUIHandler(windowControllersManagerProvider: {
             return WindowControllersManager.shared
         })
@@ -302,6 +311,8 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
             WKHTTPCookieStoreWrapper(store: WKWebsiteDataStore.default().httpCookieStore)
         }, eventMapping: SubscriptionCookieManageEventPixelMapping())
 
+        // MARK: -
+
         // Update VPN environment and match the Subscription environment
         vpnSettings.alignTo(subscriptionEnvironment: subscriptionManager.currentEnvironment)
 
@@ -321,7 +332,6 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
         freemiumDBPFeature = DefaultFreemiumDBPFeature(privacyConfigurationManager: ContentBlocking.shared.privacyConfigurationManager,
                                                        experimentManager: experimentManager,
                                                        subscriptionManager: subscriptionManager,
-                                                       accountManager: subscriptionManager.accountManager,
                                                        freemiumDBPUserStateManager: freemiumDBPUserStateManager)
         freemiumDBPPromotionViewCoordinator = FreemiumDBPPromotionViewCoordinator(freemiumDBPUserStateManager: freemiumDBPUserStateManager,
                                                                                   freemiumDBPFeature: freemiumDBPFeature)
@@ -406,8 +416,6 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
 
         startupSync()
 
-        subscriptionManager.loadInitialData()
-
         let privacyConfigurationManager = ContentBlocking.shared.privacyConfigurationManager
 
         // Enable subscriptionCookieManager if feature flag is present
@@ -481,8 +489,7 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
         dataBrokerProtectionSubscriptionEventHandler.registerForSubscriptionAccountManagerEvents()
 
         let freemiumDBPUserStateManager = DefaultFreemiumDBPUserStateManager(userDefaults: .dbp)
-        let pirGatekeeper = DefaultDataBrokerProtectionFeatureGatekeeper(accountManager:
-                                                                            subscriptionManager.accountManager,
+        let pirGatekeeper = DefaultDataBrokerProtectionFeatureGatekeeper(subscriptionManager: subscriptionManager,
                                                                          freemiumDBPUserStateManager: freemiumDBPUserStateManager)
 
         DataBrokerProtectionAppEvents(featureGatekeeper: pirGatekeeper).applicationDidFinishLaunching()
@@ -539,23 +546,18 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
         NetworkProtectionAppEvents(featureGatekeeper: DefaultVPNFeatureGatekeeper(subscriptionManager: subscriptionManager)).applicationDidBecomeActive()
 
         let freemiumDBPUserStateManager = DefaultFreemiumDBPUserStateManager(userDefaults: .dbp)
-        let pirGatekeeper = DefaultDataBrokerProtectionFeatureGatekeeper(accountManager:
-                                                                            subscriptionManager.accountManager,
+        let pirGatekeeper = DefaultDataBrokerProtectionFeatureGatekeeper(subscriptionManager: subscriptionManager,
                                                                          freemiumDBPUserStateManager: freemiumDBPUserStateManager)
 
         DataBrokerProtectionAppEvents(featureGatekeeper: pirGatekeeper).applicationDidBecomeActive()
 
-        subscriptionManager.refreshCachedSubscriptionAndEntitlements { isSubscriptionActive in
-            if isSubscriptionActive {
-                PixelKit.fire(PrivacyProPixel.privacyProSubscriptionActive, frequency: .daily)
-            }
+        // Subscription initial tasks
+        Task {
+            await subscriptionManager.loadInitialData()
         }
 
         Task { @MainActor in
             await vpnRedditSessionWorkaround.installRedditSessionWorkaround()
-        }
-
-        Task { @MainActor in
             await subscriptionCookieManager.refreshSubscriptionCookie()
         }
     }

DuckDuckGo/Common/Extensions/WKWebViewExtension.swift

@@ -403,7 +403,7 @@ extension WKWebView {
 
     // prevent exception if private API keys go missing
     open override func value(forUndefinedKey key: String) -> Any? {
-        assertionFailure("valueForUndefinedKey: \(key)")
+        // assertionFailure("valueForUndefinedKey: \(key)") // Temporary disabled https://app.asana.com/0/1199230911884351/1209123691403049/f
         return nil
     }
 

DuckDuckGo/Configuration/ConfigurationManager.swift

@@ -116,6 +116,8 @@ final class ConfigurationManager: DefaultConfigurationManager {
             do {
                 try await task.value
                 didFetchAnyTrackerBlockingDependencies = true
+            } catch APIRequest.Error.invalidStatusCode(304) {
+                tryAgainSoon()
             } catch {
                 Logger.config.error(
                     "Failed to complete configuration update to \(configuration.rawValue, privacy: .public): \(error.localizedDescription, privacy: .public)"

DuckDuckGo/DBP/DataBrokerPrerequisitesStatusVerifier.swift

@@ -20,6 +20,7 @@ import Foundation
 import Combine
 import DataBrokerProtection
 import LoginItems
+import os.log
 
 enum DataBrokerPrerequisitesStatus {
     case invalidDirectory
@@ -40,10 +41,13 @@ final class DefaultDataBrokerPrerequisitesStatusVerifier: DataBrokerPrerequisite
 
     func checkStatus() -> DataBrokerPrerequisitesStatus {
         if !statusChecker.doesHaveNecessaryPermissions() {
+            Logger.dataBrokerProtection.log("Invalid system permissions")
             return .invalidSystemPermission
         } else if !statusChecker.isInCorrectDirectory() {
+            Logger.dataBrokerProtection.log("Invalid directory")
             return .invalidDirectory
         } else {
+            Logger.dataBrokerProtection.log("Valid system permissions")
             return .valid
         }
     }

DuckDuckGo/DBP/DataBrokerProtectionAppEvents.swift

@@ -20,6 +20,7 @@ import Foundation
 import LoginItems
 import Common
 import DataBrokerProtection
+import os.log
 
 struct DataBrokerProtectionAppEvents {
 
@@ -52,6 +53,7 @@ struct DataBrokerProtectionAppEvents {
             // In this case, let's disable the agent and delete any left-over data because there's nothing for it to do
             if let profileQueriesCount = try? DataBrokerProtectionManager.shared.dataManager.profileQueriesCount(),
                profileQueriesCount > 0 {
+                Logger.dataBrokerProtection.log("Found \(profileQueriesCount) profile queries in DB. Disabling agent.")
                 restartBackgroundAgent(loginItemsManager: loginItemsManager)
 
                 // Wait to make sure the agent has had time to restart before attempting to call a method on it

DuckDuckGo/DBP/DataBrokerProtectionDebugMenu.swift

@@ -249,7 +249,8 @@ final class DataBrokerProtectionDebugMenu: NSMenu {
     }
 
     @objc private func runCustomJSON() {
-        let authenticationManager = DataBrokerAuthenticationManagerBuilder.buildAuthenticationManager(subscriptionManager: Application.appDelegate.subscriptionManager)
+        let authenticationManager = DataBrokerProtectionAuthenticationManager(
+            subscriptionManager: Application.appDelegate.subscriptionManager)
         let viewController = DataBrokerRunCustomJSONViewController(authenticationManager: authenticationManager)
         let window = NSWindow(contentRect: NSRect(x: 0, y: 0, width: 500, height: 400),
                               styleMask: [.titled, .closable, .miniaturizable, .resizable],

DuckDuckGo/DBP/DataBrokerProtectionFeatureGatekeeper.swift

@@ -35,22 +35,22 @@ struct DefaultDataBrokerProtectionFeatureGatekeeper: DataBrokerProtectionFeature
     private let pixelHandler: EventMapping<DataBrokerProtectionPixels>
     private let userDefaults: UserDefaults
     private let subscriptionAvailability: SubscriptionFeatureAvailability
-    private let accountManager: AccountManager
+    private let subscriptionManager: any SubscriptionManager
     private let freemiumDBPUserStateManager: FreemiumDBPUserStateManager
 
     init(privacyConfigurationManager: PrivacyConfigurationManaging = ContentBlocking.shared.privacyConfigurationManager,
          featureDisabler: DataBrokerProtectionFeatureDisabling = DataBrokerProtectionFeatureDisabler(),
          pixelHandler: EventMapping<DataBrokerProtectionPixels> = DataBrokerProtectionPixelsHandler(),
          userDefaults: UserDefaults = .standard,
          subscriptionAvailability: SubscriptionFeatureAvailability = DefaultSubscriptionFeatureAvailability(),
-         accountManager: AccountManager,
+         subscriptionManager: any SubscriptionManager,
          freemiumDBPUserStateManager: FreemiumDBPUserStateManager) {
         self.privacyConfigurationManager = privacyConfigurationManager
         self.featureDisabler = featureDisabler
         self.pixelHandler = pixelHandler
         self.userDefaults = userDefaults
         self.subscriptionAvailability = subscriptionAvailability
-        self.accountManager = accountManager
+        self.subscriptionManager = subscriptionManager
         self.freemiumDBPUserStateManager = freemiumDBPUserStateManager
     }
 
@@ -80,28 +80,18 @@ struct DefaultDataBrokerProtectionFeatureGatekeeper: DataBrokerProtectionFeature
 
     /// Checks DBP prerequisites
     ///
-    /// Prerequisites are satisified if either:
+    /// Prerequisites are satisfied if either:
     /// 1. The user is an active freemium user (e.g has activated freemium and is not authenticated)
     /// 2. The user has a subscription with valid entitlements
     ///
     /// - Returns: Bool indicating prerequisites are satisfied
     func arePrerequisitesSatisfied() async -> Bool {
 
-        let isAuthenticated = accountManager.isUserAuthenticated
+        let isAuthenticated = subscriptionManager.isUserAuthenticated
         if !isAuthenticated && freemiumDBPUserStateManager.didActivate { return true }
 
-        let entitlements = await accountManager.hasEntitlement(forProductName: .dataBrokerProtection,
-                                                               cachePolicy: .reloadIgnoringLocalCacheData)
-        var hasEntitlements: Bool
-        switch entitlements {
-        case .success(let value):
-            hasEntitlements = value
-        case .failure:
-            hasEntitlements = false
-        }
-
+        let hasEntitlements = await subscriptionManager.isFeatureActive(.dataBrokerProtection)
         firePrerequisitePixelsAndLogIfNecessary(hasEntitlements: hasEntitlements, isAuthenticatedResult: isAuthenticated)
-
         return hasEntitlements && isAuthenticated
     }
 }
@@ -114,11 +104,11 @@ private extension DefaultDataBrokerProtectionFeatureGatekeeper {
 
     func firePrerequisitePixelsAndLogIfNecessary(hasEntitlements: Bool, isAuthenticatedResult: Bool) {
         if !hasEntitlements {
-            Logger.dataBrokerProtection.error("DBP feature Gatekeeper: Entitlement check failed")
+            Logger.dataBrokerProtection.log("DBP feature Gatekeeper: No Entitlements available")
         }
 
         if !isAuthenticatedResult {
-            Logger.dataBrokerProtection.error("DBP feature Gatekeeper: Authentication check failed")
+            Logger.dataBrokerProtection.log("DBP feature Gatekeeper: Authentication check failed")
         }
     }
 }

DuckDuckGo/DBP/DataBrokerProtectionManager.swift

@@ -33,10 +33,8 @@ public final class DataBrokerProtectionManager {
 
     private lazy var freemiumDBPFirstProfileSavedNotifier: FreemiumDBPFirstProfileSavedNotifier = {
         let freemiumDBPUserStateManager = DefaultFreemiumDBPUserStateManager(userDefaults: .dbp)
-        let accountManager = Application.appDelegate.subscriptionManager.accountManager
-        let freemiumDBPFirstProfileSavedNotifier = FreemiumDBPFirstProfileSavedNotifier(freemiumDBPUserStateManager: freemiumDBPUserStateManager,
-                                                                                        accountManager: accountManager)
-        return freemiumDBPFirstProfileSavedNotifier
+        return FreemiumDBPFirstProfileSavedNotifier(freemiumDBPUserStateManager: freemiumDBPUserStateManager,
+                                                    subscriptionManager: Application.appDelegate.subscriptionManager)
     }()
 
     lazy var dataManager: DataBrokerProtectionDataManager = {
@@ -57,7 +55,8 @@ public final class DataBrokerProtectionManager {
     }()
 
     private init() {
-        self.authenticationManager = DataBrokerAuthenticationManagerBuilder.buildAuthenticationManager(subscriptionManager: Application.appDelegate.subscriptionManager)
+        self.authenticationManager = DataBrokerProtectionAuthenticationManager(
+            subscriptionManager: Application.appDelegate.subscriptionManager)
     }
 
     public func isUserAuthenticated() -> Bool {