Malware protection 5: Refactor Special Error Types

Package.swift

@@ -393,7 +393,8 @@ let package = Package(
             dependencies: [
                 "Common",
                 "UserScript",
-                "BrowserServicesKit"
+                "BrowserServicesKit",
+                "MaliciousSiteProtection",
             ],
             swiftSettings: [
                 .define("DEBUG", .when(configuration: .debug))
@@ -414,7 +415,6 @@ let package = Package(
             dependencies: [
                 "Common",
                 "Networking",
-                "SpecialErrorPages",
                 "PixelKit",
             ],
             swiftSettings: [

Sources/BrowserServicesKit/Autofill/AutofillUserScript.swift

@@ -17,9 +17,9 @@
 //
 
 import Common
-import WebKit
-import UserScript
 import os.log
+import UserScript
+@preconcurrency import WebKit
 
 var previousIncontextSignupPermanentlyDismissedAt: Double?
 var previousEmailSignedIn: Bool?

Sources/BrowserServicesKit/ContentBlocking/UserScripts/SurrogatesUserScript.swift

@@ -16,11 +16,11 @@
 //  limitations under the License.
 //
 
-import WebKit
+import Common
+import ContentBlocking
 import TrackerRadarKit
 import UserScript
-import ContentBlocking
-import Common
+@preconcurrency import WebKit
 
 public protocol SurrogatesUserScriptDelegate: NSObjectProtocol {
 

Sources/BrowserServicesKit/ContentScopeScript/UserContentController.swift

@@ -18,10 +18,10 @@
 
 import Combine
 import Common
-import UserScript
-import WebKit
-import QuartzCore
 import os.log
+import QuartzCore
+import UserScript
+@preconcurrency import WebKit
 
 public protocol UserContentControllerDelegate: AnyObject {
     @MainActor

Sources/BrowserServicesKit/PrivacyConfig/Features/PrivacyFeature.swift

@@ -185,7 +185,6 @@ public enum DuckPlayerSubfeature: String, PrivacySubfeature {
 public enum MaliciousSiteProtectionSubfeature: String, PrivacySubfeature {
     public var parent: PrivacyFeature { .maliciousSiteProtection }
     case allowErrorPage
-    case allowPreferencesToggle
 }
 
 public enum SyncPromotionSubfeature: String, PrivacySubfeature {

Sources/MaliciousSiteProtection/API/APIClient.swift

@@ -101,7 +101,7 @@ struct APIClient {
         let headers = environment.headers(for: requestType)
         let url = environment.url(for: requestType)
 
-        let apiRequest = APIRequestV2(url: url, method: .get, headers: headers)
+        let apiRequest = APIRequestV2(url: url, method: .get, headers: headers, timeoutInterval: requestConfig.timeout ?? 60)
         let response = try await service.fetch(request: apiRequest)
         let result: R.Response = try response.decodeBody()
 

Sources/MaliciousSiteProtection/API/APIRequest.swift

@@ -30,6 +30,7 @@ extension APIClient {
     protocol Request {
         associatedtype Response: Decodable // Strongly-typed response type
         var requestType: APIRequestType { get } // Enumerated type of request being made
+        var timeout: TimeInterval? { get }
     }
 
     // Protocol for requests that modify a set of malicious site detection data
@@ -38,6 +39,9 @@ extension APIClient {
         init(threatKind: ThreatKind, revision: Int?)
     }
 }
+extension APIClient.Request {
+    var timeout: TimeInterval? { nil }
+}
 
 public extension APIRequestType {
     struct HashPrefixes: APIClient.ChangeSetRequest {
@@ -96,6 +100,8 @@ public extension APIRequestType {
         var requestType: APIRequestType {
             .matches(self)
         }
+
+        var timeout: TimeInterval? { 1 }
     }
 }
 /// extension to call generic `load(_: some Request)` method like this: `load(.matches(…))`

Sources/MaliciousSiteProtection/MaliciousSiteDetector.swift

@@ -19,6 +19,7 @@
 import Common
 import CryptoKit
 import Foundation
+import Networking
 
 public protocol MaliciousSiteDetecting {
     /// Evaluates the given URL to determine its malicious category (e.g., phishing, malware).
@@ -43,8 +44,8 @@ public final class MaliciousSiteDetector: MaliciousSiteDetecting {
     private let dataManager: DataManaging
     private let eventMapping: EventMapping<Event>
 
-    public convenience init(apiEnvironment: APIClientEnvironment, dataManager: DataManager, eventMapping: EventMapping<Event>) {
-        self.init(apiClient: APIClient(environment: apiEnvironment), dataManager: dataManager, eventMapping: eventMapping)
+    public convenience init(apiEnvironment: APIClientEnvironment, service: APIService = DefaultAPIService(urlSession: .shared), dataManager: DataManager, eventMapping: EventMapping<Event>) {
+        self.init(apiClient: APIClient(environment: apiEnvironment, service: service), dataManager: dataManager, eventMapping: eventMapping)
     }
 
     init(apiClient: APIClient.Mockable, dataManager: DataManaging, eventMapping: EventMapping<Event>) {

Sources/MaliciousSiteProtection/Model/MaliciousSiteError.swift

@@ -22,7 +22,7 @@ public struct MaliciousSiteError: Error, Equatable {
 
     public enum Code: Int {
         case phishing = 1
-        case malware = 2
+        // case malware = 2
     }
     public let code: Code
     public let failingUrl: URL
@@ -43,6 +43,13 @@ public struct MaliciousSiteError: Error, Equatable {
         self.init(code: code, failingUrl: failingUrl)
     }
 
+    public var threatKind: ThreatKind {
+        switch code {
+        case .phishing: .phishing
+        // case .malware: .malware
+        }
+    }
+
 }
 
 extension MaliciousSiteError: _ObjectiveCBridgeableError {
@@ -63,8 +70,8 @@ extension MaliciousSiteError: LocalizedError {
         switch code {
         case .phishing:
             return "Phishing detected"
-        case .malware:
-             return "Malware detected"
+        // case .malware:
+        //      return "Malware detected"
         }
     }
 

Sources/MaliciousSiteProtection/Model/ThreatKind.swift

@@ -17,23 +17,11 @@
 //
 
 import Foundation
-import SpecialErrorPages
 
-public enum ThreatKind: String, CaseIterable, CustomStringConvertible {
+public enum ThreatKind: String, CaseIterable, Codable, CustomStringConvertible {
     public var description: String { rawValue }
 
     case phishing
     // case malware
 
 }
-
-public extension ThreatKind {
-
-    var errorPageType: SpecialErrorKind {
-        switch self {
-        // case .malware: .malware
-        case .phishing: .phishing
-        }
-    }
-
-}

Sources/MaliciousSiteProtection/Services/EmbeddedDataProvider.swift

@@ -16,8 +16,8 @@
 //  limitations under the License.
 //
 
-import CryptoKit
 import Foundation
+import CryptoKit
 
 public protocol EmbeddedDataProviding {
     func revision(for dataType: DataManager.StoredDataType) -> Int

Sources/MaliciousSiteProtection/Services/UpdateManager.swift

@@ -16,8 +16,9 @@
 //  limitations under the License.
 //
 
-import Foundation
 import Common
+import Foundation
+import Networking
 import os
 
 protocol UpdateManaging {
@@ -35,8 +36,8 @@ public struct UpdateManager: UpdateManaging {
     private let updateIntervalProvider: UpdateIntervalProvider
     private let sleeper: Sleeper
 
-    public init(apiEnvironment: APIClientEnvironment, dataManager: DataManager, updateIntervalProvider: @escaping UpdateIntervalProvider) {
-        self.init(apiClient: APIClient(environment: apiEnvironment), dataManager: dataManager, updateIntervalProvider: updateIntervalProvider)
+    public init(apiEnvironment: APIClientEnvironment, service: APIService = DefaultAPIService(urlSession: .shared), dataManager: DataManager, updateIntervalProvider: @escaping UpdateIntervalProvider) {
+        self.init(apiClient: APIClient(environment: apiEnvironment, service: service), dataManager: dataManager, updateIntervalProvider: updateIntervalProvider)
     }
 
     init(apiClient: APIClient.Mockable, dataManager: DataManaging, sleeper: Sleeper = .default, updateIntervalProvider: @escaping UpdateIntervalProvider) {
@@ -80,7 +81,10 @@ public struct UpdateManager: UpdateManaging {
                 for dataType in DataManager.StoredDataType.allCases {
                     // get update interval from provider
                     guard let updateInterval = updateIntervalProvider(dataType) else { continue }
-                    assert(updateInterval > 0)
+                    guard updateInterval > 0 else {
+                        assertionFailure("Update interval for \(dataType) must be positive")
+                        continue
+                    }
 
                     group.addTask {
                         // run periodically until the parent task is cancelled

Sources/Navigation/Extensions/WKErrorExtension.swift

@@ -34,9 +34,13 @@
     }
 
     public var isServerCertificateUntrusted: Bool {
-        code.rawValue == NSURLErrorServerCertificateUntrusted && _nsError.domain == NSURLErrorDomain
+        _nsError.isServerCertificateUntrusted
+    }
+}
+extension NSError {
+    public var isServerCertificateUntrusted: Bool {
+        code == NSURLErrorServerCertificateUntrusted && domain == NSURLErrorDomain
     }
-
 }
 
 extension WKError {
@@ -56,7 +60,7 @@
 #endif
 }
 
 extension WKError: LocalizedError {
 
     public var errorDescription: String? {
         "<WKError \((self as NSError).domain) error \(code.rawValue) \"\(self.localizedDescription)\"" +

Sources/PrivacyDashboard/PrivacyDashboardController.swift

@@ -265,12 +265,7 @@ extension PrivacyDashboardController: WKNavigationDelegate {
             .receive(on: DispatchQueue.main )
             .sink(receiveValue: { [weak self] detectedThreatKind in
                 guard let self, let webView else { return }
-                for threatKind in MaliciousSiteProtection.ThreatKind.allCases {
-                    switch threatKind {
-                    case .phishing:
-                        script.setIsPhishing(detectedThreatKind == threatKind, webView: webView)
-                    }
-                }
+                script.setMaliciousSiteDetectedThreatKind(detectedThreatKind, webView: webView)
             })
             .store(in: &cancellables)
     }

Sources/PrivacyDashboard/PrivacyDashboardUserScript.swift

@@ -16,12 +16,13 @@
 //  limitations under the License.
 //
 
+import BrowserServicesKit
+import Common
 import Foundation
-import WebKit
+import MaliciousSiteProtection
 import TrackerRadarKit
 import UserScript
-import Common
-import BrowserServicesKit
+import WebKit
 
 @MainActor
 protocol PrivacyDashboardUserScriptDelegate: AnyObject {
@@ -425,8 +426,8 @@ final class PrivacyDashboardUserScript: NSObject, StaticUserScript {
         evaluate(js: "window.onChangeCertificateData(\(certificateDataJson))", in: webView)
     }
 
-    func setIsPhishing(_ isPhishing: Bool, webView: WKWebView) {
-        let phishingStatus = ["phishingStatus": isPhishing]
+    func setMaliciousSiteDetectedThreatKind(_ detectedThreatKind: MaliciousSiteProtection.ThreatKind?, webView: WKWebView) {
+        let phishingStatus = ["phishingStatus": detectedThreatKind == .phishing]
         guard let phishingStatusJson = try? JSONEncoder().encode(phishingStatus).utf8String() else {
             assertionFailure("Can't encode phishingStatus into JSON")
             return

Sources/SpecialErrorPages/SSLErrorType.swift

@@ -17,28 +17,27 @@
 //
 
 import Foundation
+import WebKit
 
-public enum SSLErrorType: String {
+public let SSLErrorCodeKey = "_kCFStreamErrorCodeKey"
+
+public enum SSLErrorType: String, Encodable {
 
     case expired
-    case wrongHost
     case selfSigned
+    case wrongHost
     case invalid
 
-    public static func forErrorCode(_ errorCode: Int) -> Self {
-        switch Int32(errorCode) {
-        case errSSLCertExpired:
-            return .expired
-        case errSSLHostNameMismatch:
-            return .wrongHost
-        case errSSLXCertChainInvalid:
-            return .selfSigned
-        default:
-            return .invalid
+    init(errorCode: Int32) {
+        self = switch errorCode {
+        case errSSLCertExpired: .expired
+        case errSSLXCertChainInvalid: .selfSigned
+        case errSSLHostNameMismatch: .wrongHost
+        default: .invalid
         }
     }
 
-    public var rawParameter: String {
+    public var pixelParameter: String {
         switch self {
         case .expired: return "expired"
         case .wrongHost: return "wrong_host"
@@ -48,3 +47,16 @@ public enum SSLErrorType: String {
     }
 
 }
+
+extension WKError {
+    public var sslErrorType: SSLErrorType? {
+        _nsError.sslErrorType
+    }
+}
+extension NSError {
+    public var sslErrorType: SSLErrorType? {
+        guard let errorCode = self.userInfo[SSLErrorCodeKey] as? Int32 else { return nil }
+        let sslErrorType = SSLErrorType(errorCode: errorCode)
+        return sslErrorType
+    }
+}