Malware protection 6: Malware integration

Package.resolved

@@ -14,8 +14,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/duckduckgo/content-scope-scripts",
       "state" : {
-        "revision" : "c4bb146afdf0c7a93fb9a7d95b1cb255708a470d",
-        "version" : "6.41.0"
+        "revision" : "93ea6c3e771bc0b743b38cefbff548c10add9898",
+        "version" : "6.42.0"
       }
     },
     {
@@ -50,8 +50,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/duckduckgo/privacy-dashboard",
       "state" : {
-        "revision" : "49db79829dcb166b3524afdbc1c680890452ce1c",
-        "version" : "7.2.1"
+        "revision" : "022c845b06ace6a4aa712a4fa3e79da32193d5c6",
+        "version" : "7.4.0"
       }
     },
     {

Package.swift

@@ -55,8 +55,8 @@ let package = Package(
         .package(url: "https://github.com/duckduckgo/TrackerRadarKit", exact: "3.0.0"),
         .package(url: "https://github.com/duckduckgo/sync_crypto", exact: "0.3.0"),
         .package(url: "https://github.com/gumob/PunycodeSwift.git", exact: "3.0.0"),
-        .package(url: "https://github.com/duckduckgo/content-scope-scripts", exact: "6.41.0"),
-        .package(url: "https://github.com/duckduckgo/privacy-dashboard", exact: "7.2.1"),
+        .package(url: "https://github.com/duckduckgo/content-scope-scripts", exact: "6.42.0"),
+        .package(url: "https://github.com/duckduckgo/privacy-dashboard", exact: "7.4.0"),
         .package(url: "https://github.com/httpswift/swifter.git", exact: "1.5.0"),
         .package(url: "https://github.com/duckduckgo/bloom_cpp.git", exact: "3.0.0"),
         .package(url: "https://github.com/1024jp/GzipSwift.git", exact: "6.0.1"),

Sources/Configuration/DefaultConfigurationManager.swift

@@ -96,7 +96,8 @@ open class DefaultConfigurationManager: NSObject {
 
     public func start() {
         Logger.config.debug("Starting configuration refresh timer")
-        refreshTask = Task.periodic(interval: Constants.refreshCheckIntervalSeconds) { [weak self] in
+        refreshTask = Task.periodic(delay: Constants.refreshCheckIntervalSeconds, // add initial delay as we‘re firing `refreshNow`
+                                    interval: Constants.refreshCheckIntervalSeconds) { [weak self] in
             Self.queue.async { [weak self] in
                 self?.lastRefreshCheckTime = Date()
                 self?.refreshIfNeeded()

Sources/MaliciousSiteProtection/API/APIClient.swift

@@ -31,6 +31,11 @@ extension APIClient: APIClient.Mockable {}
 public protocol APIClientEnvironment {
     func headers(for requestType: APIRequestType) -> APIRequestV2.HeadersV2
     func url(for requestType: APIRequestType) -> URL
+    func timeout(for requestType: APIRequestType) -> TimeInterval?
+}
+
+public extension APIClientEnvironment {
+    func timeout(for requestType: APIRequestType) -> TimeInterval? { nil }
 }
 
 public extension MaliciousSiteDetector {
@@ -100,8 +105,9 @@ struct APIClient {
         let requestType = requestConfig.requestType
         let headers = environment.headers(for: requestType)
         let url = environment.url(for: requestType)
+        let timeout = environment.timeout(for: requestType) ?? requestConfig.defaultTimeout ?? 60
 
-        let apiRequest = APIRequestV2(url: url, method: .get, headers: headers, timeoutInterval: requestConfig.timeout ?? 60)
+        let apiRequest = APIRequestV2(url: url, method: .get, headers: headers, timeoutInterval: timeout)
         let response = try await service.fetch(request: apiRequest)
         let result: R.Response = try response.decodeBody()
 

Sources/MaliciousSiteProtection/API/APIRequest.swift

@@ -30,7 +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 }
+        var defaultTimeout: TimeInterval? { get }
     }
 
     // Protocol for requests that modify a set of malicious site detection data
@@ -40,7 +40,7 @@ extension APIClient {
     }
 }
 extension APIClient.Request {
-    var timeout: TimeInterval? { nil }
+    var defaultTimeout: TimeInterval? { nil }
 }
 
 public extension APIRequestType {
@@ -101,7 +101,7 @@ public extension APIRequestType {
             .matches(self)
         }
 
-        var timeout: TimeInterval? { 1 }
+        var defaultTimeout: TimeInterval? { 10 }
     }
 }
 /// extension to call generic `load(_: some Request)` method like this: `load(.matches(…))`

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
@@ -37,16 +37,16 @@ public struct MaliciousSiteError: Error, Equatable {
         switch threat {
         case .phishing:
             code = .phishing
-        // case .malware:
-        //    code = .malware
+        case .malware:
+           code = .malware
         }
         self.init(code: code, failingUrl: failingUrl)
     }
 
     public var threatKind: ThreatKind {
         switch code {
         case .phishing: .phishing
-        // case .malware: .malware
+        case .malware: .malware
         }
     }
 
@@ -70,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

@@ -22,6 +22,6 @@ public enum ThreatKind: String, CaseIterable, Codable, CustomStringConvertible {
     public var description: String { rawValue }
 
     case phishing
-    // case malware
+    case malware
 
 }

Sources/Navigation/Extensions/WKErrorExtension.swift

@@ -36,6 +36,10 @@
     public var isServerCertificateUntrusted: Bool {
         _nsError.isServerCertificateUntrusted
     }
+
+    public var isWebContentProcessTerminated: Bool {
+        code == .webContentProcessTerminated && _nsError is WKError
+    }
 }
 extension NSError {
     public var isServerCertificateUntrusted: Bool {
@@ -60,7 +64,7 @@
 #endif
 }
 
 extension WKError: LocalizedError {
 
     public var errorDescription: String? {
         "<WKError \((self as NSError).domain) error \(code.rawValue) \"\(self.localizedDescription)\"" +

Sources/PrivacyDashboard/PrivacyDashboardUserScript.swift

@@ -427,12 +427,15 @@ final class PrivacyDashboardUserScript: NSObject, StaticUserScript {
     }
 
     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")
+        let statusJson: String
+        do {
+            let obj = ["kind": detectedThreatKind?.rawValue ?? NSNull() as Any]
+            statusJson = try JSONSerialization.data(withJSONObject: obj).utf8String()!
+        } catch {
+            assertionFailure("Can't encode status: \(error)")
             return
         }
-        evaluate(js: "window.onChangePhishingStatus(\(phishingStatusJson))", in: webView)
+        evaluate(js: "window.onChangeMaliciousSiteStatus(\(statusJson))", in: webView)
     }
 
     func setIsPendingUpdates(_ isPendingUpdates: Bool, webView: WKWebView) {

Sources/SpecialErrorPages/SpecialErrorData.swift

@@ -22,7 +22,7 @@ import MaliciousSiteProtection
 public enum SpecialErrorKind: String, Encodable {
     case ssl
     case phishing
-    // case malware
+    case malware
 }
 
 public enum SpecialErrorData: Encodable, Equatable {
@@ -70,7 +70,7 @@ public enum SpecialErrorData: Encodable, Equatable {
 public extension MaliciousSiteProtection.ThreatKind {
     var errorPageKind: SpecialErrorKind {
         switch self {
-        // case .malware: .malware
+        case .malware: .malware
         case .phishing: .phishing
         }
     }

Sources/SpecialErrorPages/SpecialErrorPageUserScript.swift

@@ -71,21 +71,22 @@ public final class SpecialErrorPageUserScript: NSObject, Subfeature {
         self.languageCode = languageCode
     }
 
-    @MainActor
     public func handler(forMethodNamed methodName: String) -> Subfeature.Handler? {
-        guard isEnabled, let messageName = MessageName(rawValue: methodName) else { return nil }
-        return methodHandlers[messageName]
+        guard isEnabled else { return nil }
+
+        switch MessageName(rawValue: methodName) {
+        case .initialSetup: return initialSetup
+        case .reportPageException: return reportPageException
+        case .reportInitException: return reportInitException
+        case .leaveSite: return handleLeaveSiteAction
+        case .visitSite: return handleVisitSiteAction
+        case .advancedInfo: return handleAdvancedInfoPresented
+        default:
+            assertionFailure("SpecialErrorPageUserScript: Failed to parse User Script message: \(methodName)")
+            return nil
+        }
     }
 
-    private lazy var methodHandlers: [MessageName: Handler] = [
-        .initialSetup: initialSetup,
-        .reportPageException: reportPageException,
-        .reportInitException: reportInitException,
-        .leaveSite: handleLeaveSiteAction,
-        .visitSite: handleVisitSiteAction,
-        .advancedInfo: handleAdvancedInfoPresented
-    ]
-
     @MainActor
     private func initialSetup(params: Any, original: WKScriptMessage) async throws -> Encodable? {
 #if DEBUG

Sources/Suggestions/SuggestionLoading.swift

@@ -90,11 +90,11 @@ public class SuggestionLoader: SuggestionLoading {
             guard let self = self else { return }
             let processor = SuggestionProcessing(platform: dataSource.platform, urlFactory: self.urlFactory)
             let result = processor.result(for: query,
-                                                 from: history,
-                                                 bookmarks: bookmarks,
-                                                 internalPages: internalPages,
-                                                 openTabs: openTabs,
-                                                 apiResult: apiResult)
+                                          from: history,
+                                          bookmarks: bookmarks,
+                                          internalPages: internalPages,
+                                          openTabs: openTabs,
+                                          apiResult: apiResult)
             DispatchQueue.main.async {
                 if let result = result {
                     completion(result, apiError)

Tests/MaliciousSiteProtectionTests/MaliciousSiteProtectionEmbeddedDataProviderTest.swift

@@ -42,11 +42,15 @@ class MaliciousSiteProtectionEmbeddedDataProviderTest: XCTestCase {
                 switch key.threatKind {
                 case .phishing:
                     "4fd2868a4f264501ec175ab866504a2a96c8d21a3b5195b405a4a83b51eae504"
+                case .malware:
+                    "7f80bcae89250c4ecc4ed91b5a4c3a09fe6f098622369f2f46a8ab69023a7683"
                 }
             case .hashPrefixSet(let key):
                 switch key.threatKind {
                 case .phishing:
                     "21b047a9950fcaf86034a6b16181e18815cb8d276386d85c8977ca8c5f8aa05f"
+                case .malware:
+                    "ef31819296d83136cdb131e877e08fd120571d4c82512ba8c3eb964885ec07bc"
                 }
             }
         }

Tests/MaliciousSiteProtectionTests/MaliciousSiteProtectionUpdateManagerTests.swift

@@ -335,7 +335,7 @@ class MaliciousSiteProtectionUpdateManagerTests: XCTestCase {
             XCTestExpectation(description: "Will Sleep 3"),
         ]
         self.willSleep = { _ in
-            sleepExpectations[sleepIndex].fulfill()
+            sleepExpectations[safe: sleepIndex]?.fulfill()
             sleepIndex += 1
         }
 

Tests/MaliciousSiteProtectionTests/Mocks/MockMaliciousSiteProtectionEmbeddedDataProvider.swift

@@ -65,7 +65,6 @@ final class MockMaliciousSiteProtectionEmbeddedDataProvider: MaliciousSiteProtec
     }
 
     func data(withContentsOf url: URL) throws -> Data {
-        let data: Data
         switch url.absoluteString {
         case "filterSet":
             self.loadFilterSetCalled = true

Tests/MaliciousSiteProtectionTests/Resources/malwareFilterSet.json

@@ -0,0 +1,6 @@
+[
+  {
+    "hash": "e4753ddad954dafd4ff4ef67f82b3c1a2db6ef4a51bda43513260170e558bd13",
+    "regex": "(?i)^https?\\:\\/\\/privacy-test-pages\\.site(?:\\:(?:80|443))?\\/security\\/badware\\/malware\\.html$"
+  }
+]

Tests/MaliciousSiteProtectionTests/Resources/malwareHashPrefixes.json

@@ -0,0 +1,5 @@
+[
+  "e4753dda",
+  "012db806",
+  "56fbfbf2"
+]

Tests/PrivacyDashboardTests/PrivacyDashboardControllerTests.swift

@@ -16,11 +16,13 @@
 //  limitations under the License.
 //
 
-import XCTest
 import Common
+import os
 import WebKit
-@testable import PrivacyDashboard
+import XCTest
+
 @testable import BrowserServicesKit
+@testable import PrivacyDashboard
 
 @MainActor
 final class PrivacyDashboardControllerTests: XCTestCase {
@@ -268,8 +270,8 @@ final class PrivacyDashboardControllerTests: XCTestCase {
 
         privacyDashboardController.privacyInfo!.malicousSiteThreatKind = .phishing
 
-        wait(for: [expectation], timeout: 100)
-        XCTAssertEqual(mockWebView.capturedJavaScriptString, "window.onChangePhishingStatus({\"phishingStatus\":true})")
+        wait(for: [expectation], timeout: 5)
+        XCTAssertEqual(mockWebView.capturedJavaScriptString, "window.onChangeMaliciousSiteStatus({\"kind\":\"phishing\"})")
     }
 }
 
@@ -287,8 +289,8 @@ class MockWebView: WKWebView {
     }
 
     override func evaluateJavaScript(_ javaScriptString: String) async throws -> Any {
-        print(javaScriptString)
-        if javaScriptString.contains("window.onChangePhishingStatus") {
+        Logger(subsystem: Bundle.main.bundleIdentifier!, category: "DDGTest").info("received javaScriptString \(javaScriptString, privacy: .public)")
+        if javaScriptString.contains("window.onChangeMaliciousSiteStatus") {
             capturedJavaScriptString = javaScriptString
             expectation.fulfill()
         }