Malicious site protection address bar and privacy dashboard changes (#…

…3718) Task/Issue URL: https://app.asana.com/0/1206329551987282/1208959082985728/f Tech Design: https://app.asana.com/0/1206329551987282/1207273224076495/f **Description**: This PR addresses the following: 1. Updates the Privacy Icon to use the globe asset when visiting special error pages (SSL error included). 2. Updates the Privacy icon to use the alert asset when the user accepts the risk of visiting a malicious page. 3. Show an updated privacy dashboard for phishing and malware special error pages.
duckduckgo · Jan 14, 2025 · cd64847 · cd64847
1 parent b6373fc
commit cd64847
Show file tree

Hide file tree

Showing 18 changed files with 209 additions and 23 deletions.
diff --git a/DuckDuckGo.xcodeproj/project.pbxproj b/DuckDuckGo.xcodeproj/project.pbxproj
@@ -799,6 +799,7 @@
 		9F254B032CF9FB2E0063B308 /* SpecialErrorPageNavigationDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F254B022CF9FB2E0063B308 /* SpecialErrorPageNavigationDelegate.swift */; };
 		9F254B052CF9FB890063B308 /* SpecialErrorPageContextHandling.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F254B042CF9FB890063B308 /* SpecialErrorPageContextHandling.swift */; };
 		9F254B082CF9FC270063B308 /* SpecialErrorModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F254B072CF9FC270063B308 /* SpecialErrorModel.swift */; };
+		9F38A28C2D09BDE500EB100E /* SpecialErrorPageThreatProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F38A28B2D09BDE500EB100E /* SpecialErrorPageThreatProvider.swift */; };
 		9F46BEF82CD8D7490092E0EF /* OnboardingView+AddToDockContent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F46BEF72CD8D7490092E0EF /* OnboardingView+AddToDockContent.swift */; };
 		9F4CC5152C47AD08006A96EB /* ContextualOnboardingPresenterMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F4CC5142C47AD08006A96EB /* ContextualOnboardingPresenterMock.swift */; };
 		9F4CC5172C48B8D4006A96EB /* TabViewControllerDaxDialogTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F4CC5162C48B8D4006A96EB /* TabViewControllerDaxDialogTests.swift */; };
@@ -2694,6 +2695,7 @@
 		9F254B022CF9FB2E0063B308 /* SpecialErrorPageNavigationDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SpecialErrorPageNavigationDelegate.swift; sourceTree = "<group>"; };
 		9F254B042CF9FB890063B308 /* SpecialErrorPageContextHandling.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SpecialErrorPageContextHandling.swift; sourceTree = "<group>"; };
 		9F254B072CF9FC270063B308 /* SpecialErrorModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SpecialErrorModel.swift; sourceTree = "<group>"; };
+		9F38A28B2D09BDE500EB100E /* SpecialErrorPageThreatProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SpecialErrorPageThreatProvider.swift; sourceTree = "<group>"; };
 		9F46BEF72CD8D7490092E0EF /* OnboardingView+AddToDockContent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "OnboardingView+AddToDockContent.swift"; sourceTree = "<group>"; };
 		9F4CC5142C47AD08006A96EB /* ContextualOnboardingPresenterMock.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ContextualOnboardingPresenterMock.swift; sourceTree = "<group>"; };
 		9F4CC5162C48B8D4006A96EB /* TabViewControllerDaxDialogTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TabViewControllerDaxDialogTests.swift; sourceTree = "<group>"; };
@@ -5230,6 +5232,7 @@
 				9F254B002CF9FA8D0063B308 /* SpecialErrorPageActionHandler.swift */,
 				9F254B022CF9FB2E0063B308 /* SpecialErrorPageNavigationDelegate.swift */,
 				9F254B042CF9FB890063B308 /* SpecialErrorPageContextHandling.swift */,
+				9F38A28B2D09BDE500EB100E /* SpecialErrorPageThreatProvider.swift */,
 			);
 			path = SpecialErrorPageInterfaces;
 			sourceTree = "<group>";
@@ -8285,6 +8288,7 @@
 				F42EF9312614BABE00101FB9 /* ActionSheetDaxDialogViewController.swift in Sources */,
 				EEC02C142B0519DE0045CE11 /* NetworkProtectionVPNLocationViewModel.swift in Sources */,
 				D63FF8962C1B67E9006DE24D /* YoutubeOverlayUserScript.swift in Sources */,
+				9F38A28C2D09BDE500EB100E /* SpecialErrorPageThreatProvider.swift in Sources */,
 				F13B4BC01F180D8A00814661 /* TabsModel.swift in Sources */,
 				8598D2E02CEB98B500C45685 /* Favicons.swift in Sources */,
 				8598D2E12CEB98B500C45685 /* NotFoundCachingDownloader.swift in Sources */,
@@ -12003,8 +12007,8 @@
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/DuckDuckGo/BrowserServicesKit";
 			requirement = {
-				kind = exactVersion;
-				version = 224.1.0;
+				branch = "alessandro/malicious-site-protection-ios";
+				kind = branch;
 			};
 		};
 		9F8FE9472BAE50E50071E372 /* XCRemoteSwiftPackageReference "lottie-spm" */ = {

diff --git a/DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
@@ -32,8 +32,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/DuckDuckGo/BrowserServicesKit",
       "state" : {
-        "revision" : "14384f05a6e43842c4626e06736e2c4f5d758057",
-        "version" : "224.1.0"
+        "branch" : "alessandro/malicious-site-protection-ios",
+        "revision" : "797518c8dab1455af63f64844a202097c0ff8e40"
       }
     },
     {
@@ -122,8 +122,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/duckduckgo/privacy-dashboard",
       "state" : {
-        "revision" : "2e2baf7d31c7d8e158a58bc1cb79498c1c727fd2",
-        "version" : "7.5.0"
+        "revision" : "bea4d750913ef82c10cd06e791686501c8e648e4",
+        "version" : "7.6.0"
       }
     },
     {

diff --git a/...o/Assets.xcassets/DesignSystemIcons/24px/Alert-Color-24.imageset/Alert-Recolorable-24.pdf b/...o/Assets.xcassets/DesignSystemIcons/24px/Alert-Color-24.imageset/Alert-Recolorable-24.pdf
diff --git a/DuckDuckGo/Assets.xcassets/DesignSystemIcons/24px/Alert-Color-24.imageset/Contents.json b/DuckDuckGo/Assets.xcassets/DesignSystemIcons/24px/Alert-Color-24.imageset/Contents.json
@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "filename" : "Alert-Recolorable-24.pdf",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}
diff --git a/DuckDuckGo/Base.lproj/OmniBar.xib b/DuckDuckGo/Base.lproj/OmniBar.xib
@@ -166,7 +166,7 @@
                                                                 <constraint firstAttribute="width" constant="158" id="yFt-j7-mPi"/>
                                                             </constraints>
                                                         </view>
-                                                        <imageView clipsSubviews="YES" userInteractionEnabled="NO" contentMode="center" horizontalHuggingPriority="251" verticalHuggingPriority="251" image="LogoIcon" translatesAutoresizingMaskIntoConstraints="NO" id="eoZ-Ly-QHi">
+                                                        <imageView clipsSubviews="YES" userInteractionEnabled="NO" contentMode="center" horizontalHuggingPriority="251" verticalHuggingPriority="251" translatesAutoresizingMaskIntoConstraints="NO" id="eoZ-Ly-QHi">
                                                             <rect key="frame" x="0.0" y="2" width="43" height="38"/>
                                                         </imageView>
                                                     </subviews>
@@ -185,9 +185,9 @@
                                                         <constraint firstItem="eoZ-Ly-QHi" firstAttribute="leading" secondItem="99p-YW-bjm" secondAttribute="leading" id="VgX-60-gzX"/>
                                                     </constraints>
                                                     <connections>
-                                                        <outlet property="daxLogoImageView" destination="eoZ-Ly-QHi" id="aTN-UG-1Em"/>
                                                         <outlet property="shieldAnimationView" destination="dqb-pm-Da8" id="m3S-lp-2hi"/>
                                                         <outlet property="shieldDotAnimationView" destination="D46-aN-352" id="yuP-Tc-fZl"/>
+                                                        <outlet property="staticImageView" destination="eoZ-Ly-QHi" id="DD9-w9-GZy"/>
                                                         <outlet property="staticShieldAnimationView" destination="jQy-me-Afa" id="pez-0Q-5Gq"/>
                                                         <outlet property="staticShieldDotAnimationView" destination="KE6-Wh-7Yp" id="92x-it-Oyn"/>
                                                         <outletCollection property="gestureRecognizers" destination="qXd-RO-1cS" appends="YES" id="3xf-ou-ORG"/>
@@ -458,7 +458,6 @@
         <image name="Clear-24" width="24" height="24"/>
         <image name="Close-24" width="24" height="24"/>
         <image name="Find-Search-20" width="20" height="20"/>
-        <image name="LogoIcon" width="24" height="24"/>
         <image name="Microphone-24" width="24" height="24"/>
         <image name="Reload-24" width="24" height="24"/>
         <image name="Settings-24" width="24" height="24"/>
@@ -467,7 +466,7 @@
             <color red="0.96078431372549022" green="0.96078431372549022" blue="0.96078431372549022" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
         </namedColor>
         <systemColor name="systemGreenColor">
-            <color red="0.20392156862745098" green="0.7803921568627451" blue="0.34901960784313724" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
+            <color red="0.20392156859999999" green="0.78039215689999997" blue="0.34901960780000002" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
         </systemColor>
         <systemColor name="systemYellowColor">
             <color red="1" green="0.80000000000000004" blue="0.0" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>

diff --git a/DuckDuckGo/OmniBar.swift b/DuckDuckGo/OmniBar.swift
@@ -29,6 +29,7 @@ extension OmniBar: NibLoading {}
 
 public enum OmniBarIcon: String {
     case duckPlayer = "DuckPlayerURLIcon"
+    case specialError = "Globe-24"
 }
 
 class OmniBar: UIView {
@@ -300,10 +301,15 @@ class OmniBar: UIView {
             showCustomIcon(icon: .duckPlayer)
             return
         }
-
-        privacyInfoContainer.privacyIcon.isHidden = privacyInfo.isSpecialErrorPageVisible
+
+        if privacyInfo.isSpecialErrorPageVisible {
+            showCustomIcon(icon: .specialError)
+            return
+        }
+
         let icon = PrivacyIconLogic.privacyIcon(for: privacyInfo)
         privacyInfoContainer.privacyIcon.updateIcon(icon)
+        privacyInfoContainer.privacyIcon.isHidden = false
         customIconView.isHidden = true
     }
 

diff --git a/DuckDuckGo/PrivacyIconLogic.swift b/DuckDuckGo/PrivacyIconLogic.swift
@@ -34,6 +34,8 @@ final class PrivacyIconLogic {
     static func privacyIcon(for privacyInfo: PrivacyInfo) -> PrivacyIcon {
         if privacyInfo.url.isDuckDuckGoSearch {
             return .daxLogo
+        } else if privacyInfo.malicousSiteThreatKind != .none {
+            return .alert
         } else {
             let config = ContentBlocking.shared.privacyConfigurationManager.privacyConfig
             let isUserUnprotected = config.isUserUnprotected(domain: privacyInfo.url.host)

diff --git a/DuckDuckGo/PrivacyIconView.swift b/DuckDuckGo/PrivacyIconView.swift
@@ -22,12 +22,20 @@ import UIKit
 import Lottie
 
 enum PrivacyIcon {
-    case daxLogo, shield, shieldWithDot
+    case daxLogo, shield, shieldWithDot, alert
+
+    fileprivate var staticImage: UIImage? {
+        switch self {
+        case .daxLogo: return UIImage(resource: .logoIcon)
+        case .alert: return UIImage(resource: .alertColor24)
+        default: return nil
+        }
+    }
 }
 
 class PrivacyIconView: UIView {
 
-    @IBOutlet var daxLogoImageView: UIImageView!
+    @IBOutlet var staticImageView: UIImageView!
     @IBOutlet var staticShieldAnimationView: LottieAnimationView!
     @IBOutlet var staticShieldDotAnimationView: LottieAnimationView!
 
@@ -91,16 +99,17 @@ class PrivacyIconView: UIView {
 
     private func updateShieldImageView(for icon: PrivacyIcon) {
         switch icon {
-        case .daxLogo:
-            daxLogoImageView.isHidden = false
+        case .daxLogo, .alert:
+            staticImageView.isHidden = false
+            staticImageView.image = icon.staticImage
             staticShieldAnimationView.isHidden = true
             staticShieldDotAnimationView.isHidden = true
         case .shield:
-            daxLogoImageView.isHidden = true
+            staticImageView.isHidden = true
             staticShieldAnimationView.isHidden = false
             staticShieldDotAnimationView.isHidden = true
         case .shieldWithDot:
-            daxLogoImageView.isHidden = true
+            staticImageView.isHidden = true
             staticShieldAnimationView.isHidden = true
             staticShieldDotAnimationView.isHidden = false
         }
@@ -116,6 +125,10 @@ class PrivacyIconView: UIView {
             accessibilityLabel = UserText.privacyIconShield
             accessibilityHint = UserText.privacyIconOpenDashboardHint
             accessibilityTraits = .button
+        case .alert:
+            accessibilityLabel = UserText.privacyIconShield
+            accessibilityHint = UserText.privacyIconOpenDashboardHint
+            accessibilityTraits = .button
         }
     }
 
@@ -134,7 +147,7 @@ class PrivacyIconView: UIView {
 
         staticShieldAnimationView.isHidden = true
         staticShieldDotAnimationView.isHidden = true
-        daxLogoImageView.isHidden = true
+        staticImageView.isHidden = true
     }
 
     func shieldAnimationView(for icon: PrivacyIcon) -> LottieAnimationView? {

diff --git a/DuckDuckGo/SpecialErrorPage/SpecialErrorPageInterfaces/SpecialErrorPageContextHandling.swift b/DuckDuckGo/SpecialErrorPage/SpecialErrorPageInterfaces/SpecialErrorPageContextHandling.swift
@@ -22,7 +22,7 @@ import WebKit
 import SpecialErrorPages
 
 /// A type that defines the base functionality for handling navigation related to special error pages.
-protocol SpecialErrorPageContextHandling: AnyObject {
+protocol SpecialErrorPageContextHandling: SpecialErrorPageThreatProvider {
     /// The delegate that handles navigation actions for special error pages.
     var delegate: SpecialErrorPageNavigationDelegate? { get set }
 

diff --git a/DuckDuckGo/SpecialErrorPage/SpecialErrorPageInterfaces/SpecialErrorPageThreatProvider.swift b/DuckDuckGo/SpecialErrorPage/SpecialErrorPageInterfaces/SpecialErrorPageThreatProvider.swift
@@ -0,0 +1,29 @@
+//
+//  SpecialErrorPageThreatProvider.swift
+//  DuckDuckGo
+//
+//  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 MaliciousSiteProtection
+
+protocol SpecialErrorPageThreatProvider: AnyObject {
+    /// Provides the current threat kind detected.
+    ///
+    /// - Returns: An optional `ThreatKind` that indicates the current threat type, or `nil` if no threat is detected.
+    @MainActor
+    var currentThreatKind: ThreatKind? { get }
+}
diff --git a/DuckDuckGo/SpecialErrorPage/SpecialErrorPageNavigationHandler+MaliciousSite.swift b/DuckDuckGo/SpecialErrorPage/SpecialErrorPageNavigationHandler+MaliciousSite.swift
@@ -34,7 +34,7 @@ enum MaliciousSiteProtectionNavigationResult: Equatable {
     }
 }
 
-protocol MaliciousSiteProtectionNavigationHandling: AnyObject {
+protocol MaliciousSiteProtectionNavigationHandling: SpecialErrorPageThreatProvider {
     /// Creates a task for detecting malicious sites based on the provided navigation action.
     ///
     /// - Parameters:
@@ -78,6 +78,11 @@ final class MaliciousSiteProtectionNavigationHandler {
 
 extension MaliciousSiteProtectionNavigationHandler: MaliciousSiteProtectionNavigationHandling {
 
+    @MainActor
+    var currentThreatKind: ThreatKind? {
+        bypassedMaliciousSiteThreatKind
+    }
+
     @MainActor
     func makeMaliciousSiteDetectionTask(for navigationAction: WKNavigationAction, webView: WKWebView) {
 

diff --git a/DuckDuckGo/SpecialErrorPage/SpecialErrorPageNavigationHandler.swift b/DuckDuckGo/SpecialErrorPage/SpecialErrorPageNavigationHandler.swift
@@ -38,6 +38,10 @@ final class SpecialErrorPageNavigationHandler: SpecialErrorPageContextHandling {
     private let sslErrorPageNavigationHandler: SSLSpecialErrorPageNavigationHandling & SpecialErrorPageActionHandler
     private let maliciousSiteProtectionNavigationHandler: MaliciousSiteProtectionNavigationHandling & SpecialErrorPageActionHandler
 
+    var currentThreatKind: ThreatKind? {
+        maliciousSiteProtectionNavigationHandler.currentThreatKind
+    }
+
     init(
         sslErrorPageNavigationHandler: SSLSpecialErrorPageNavigationHandling & SpecialErrorPageActionHandler = SSLErrorPageNavigationHandler(),
         maliciousSiteProtectionNavigationHandler: MaliciousSiteProtectionNavigationHandling & SpecialErrorPageActionHandler = MaliciousSiteProtectionNavigationHandler()

diff --git a/DuckDuckGo/TabViewController.swift b/DuckDuckGo/TabViewController.swift
@@ -1060,6 +1060,7 @@ class TabViewController: UIViewController {
         let privacyInfo = PrivacyInfo(url: url,
                                       parentEntity: entity,
                                       protectionStatus: makeProtectionStatus(for: host),
+                                      malicousSiteThreatKind: specialErrorPageNavigationHandler.currentThreatKind,
                                       shouldCheckServerTrust: shouldCheckServerTrust)
         let isValid = certificateTrustEvaluator.evaluateCertificateTrust(trust: webView.serverTrust)
         if let isValid {

diff --git a/DuckDuckGoTests/PrivacyIconLogicTests.swift b/DuckDuckGoTests/PrivacyIconLogicTests.swift
@@ -118,6 +118,32 @@ class PrivacyIconLogicTests: XCTestCase {
         XCTAssertEqual(icon, .shield)
     }
 
+    func testWhenPrivacyIconThreatKindIsPhishingThenPrivacyIconIsAlert() {
+        // GIVEN
+        let url = PrivacyIconLogicTests.pageURL
+        let protectionStatus = ProtectionStatus(unprotectedTemporary: false, enabledFeatures: [], allowlisted: true, denylisted: false)
+        let privacyInfo = PrivacyInfo(url: url, parentEntity: nil, protectionStatus: protectionStatus, malicousSiteThreatKind: .phishing)
+
+        // WHEN
+        let icon = PrivacyIconLogic.privacyIcon(for: privacyInfo)
+
+        // THEN
+        XCTAssertEqual(icon, .alert)
+    }
+
+    func testWhenPrivacyIconThreatKindIsMalwareThenPrivacyIconIsAlert() {
+        // GIVEN
+        let url = PrivacyIconLogicTests.pageURL
+        let protectionStatus = ProtectionStatus(unprotectedTemporary: false, enabledFeatures: [], allowlisted: true, denylisted: false)
+        let privacyInfo = PrivacyInfo(url: url, parentEntity: nil, protectionStatus: protectionStatus, malicousSiteThreatKind: .malware)
+
+        // WHEN
+        let icon = PrivacyIconLogic.privacyIcon(for: privacyInfo)
+
+        // THEN
+        XCTAssertEqual(icon, .alert)
+    }
+
 }
 
 final class MockSecTrust: SecurityTrust {}
diff --git a/DuckDuckGoTests/SpecialErrorPage/MaliciousSiteProtectionNavigationHandlerTests.swift b/DuckDuckGoTests/SpecialErrorPage/MaliciousSiteProtectionNavigationHandlerTests.swift
@@ -196,6 +196,27 @@ struct MaliciousSiteProtectionNavigationHandlerTests {
         #expect(sut.bypassedMaliciousSiteThreatKind == threat)
     }
 
+    @MainActor
+    @Test(
+        "Threat Kind Returns right value",
+        arguments: [
+            ThreatKind.phishing,
+            .malware
+        ]
+    )
+    func whenThreatKindIsCalledReturnRightValue(threat: ThreatKind) throws {
+        // GIVEN
+        let url = try #require(URL(string: "https://www.example.com"))
+        let error = SpecialErrorData.maliciousSite(kind: threat, url: url)
+        sut.visitSite(url: url, errorData: error)
+
+        // WHEN
+        let result = sut.currentThreatKind
+
+        // THEN
+        #expect(result == threat)
+    }
+
     @Test("Leave Site Pixel", .disabled("Will be implmented in upcoming PR"))
     func whenLeaveSiteActionThenFirePixel() throws {