1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
3 /* This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
7 #include "UrlClassifierFeatureTrackingProtection.h"
9 #include "mozilla/AntiTrackingUtils.h"
10 #include "mozilla/net/UrlClassifierCommon.h"
11 #include "ChannelClassifierService.h"
12 #include "nsIChannel.h"
13 #include "nsIHttpChannelInternal.h"
14 #include "nsILoadContext.h"
15 #include "nsNetUtil.h"
16 #include "mozilla/StaticPtr.h"
17 #include "nsXULAppAPI.h"
18 #include "nsIWebProgressListener.h"
25 #define TRACKING_PROTECTION_FEATURE_NAME "tracking-protection"
27 #define URLCLASSIFIER_TRACKING_BLOCKLIST "urlclassifier.trackingTable"
28 #define URLCLASSIFIER_TRACKING_BLOCKLIST_TEST_ENTRIES \
29 "urlclassifier.trackingTable.testEntries"
30 #define URLCLASSIFIER_TRACKING_ENTITYLIST "urlclassifier.trackingWhitelistTable"
31 #define URLCLASSIFIER_TRACKING_ENTITYLIST_TEST_ENTRIES \
32 "urlclassifier.trackingWhitelistTable.testEntries"
33 #define URLCLASSIFIER_TRACKING_PROTECTION_EXCEPTION_URLS \
34 "urlclassifier.trackingSkipURLs"
35 #define TABLE_TRACKING_BLOCKLIST_PREF "tracking-blocklist-pref"
36 #define TABLE_TRACKING_ENTITYLIST_PREF "tracking-entitylist-pref"
38 StaticRefPtr
<UrlClassifierFeatureTrackingProtection
> gFeatureTrackingProtection
;
42 UrlClassifierFeatureTrackingProtection::UrlClassifierFeatureTrackingProtection()
43 : UrlClassifierFeatureAntiTrackingBase(
44 nsLiteralCString(TRACKING_PROTECTION_FEATURE_NAME
),
45 nsLiteralCString(URLCLASSIFIER_TRACKING_BLOCKLIST
),
46 nsLiteralCString(URLCLASSIFIER_TRACKING_ENTITYLIST
),
47 nsLiteralCString(URLCLASSIFIER_TRACKING_BLOCKLIST_TEST_ENTRIES
),
48 nsLiteralCString(URLCLASSIFIER_TRACKING_ENTITYLIST_TEST_ENTRIES
),
49 nsLiteralCString(TABLE_TRACKING_BLOCKLIST_PREF
),
50 nsLiteralCString(TABLE_TRACKING_ENTITYLIST_PREF
),
51 nsLiteralCString(URLCLASSIFIER_TRACKING_PROTECTION_EXCEPTION_URLS
)) {}
53 /* static */ const char* UrlClassifierFeatureTrackingProtection::Name() {
54 return TRACKING_PROTECTION_FEATURE_NAME
;
58 void UrlClassifierFeatureTrackingProtection::MaybeInitialize() {
59 MOZ_ASSERT(XRE_IsParentProcess());
60 UC_LOG_LEAK(("UrlClassifierFeatureTrackingProtection::MaybeInitialize"));
62 if (!gFeatureTrackingProtection
) {
63 gFeatureTrackingProtection
= new UrlClassifierFeatureTrackingProtection();
64 gFeatureTrackingProtection
->InitializePreferences();
69 void UrlClassifierFeatureTrackingProtection::MaybeShutdown() {
70 UC_LOG_LEAK(("UrlClassifierFeatureTrackingProtection::MaybeShutdown"));
72 if (gFeatureTrackingProtection
) {
73 gFeatureTrackingProtection
->ShutdownPreferences();
74 gFeatureTrackingProtection
= nullptr;
79 already_AddRefed
<UrlClassifierFeatureTrackingProtection
>
80 UrlClassifierFeatureTrackingProtection::MaybeCreate(nsIChannel
* aChannel
) {
84 ("UrlClassifierFeatureTrackingProtection::MaybeCreate - channel %p",
87 nsCOMPtr
<nsILoadContext
> loadContext
;
88 NS_QueryNotificationCallbacks(aChannel
, loadContext
);
90 // Some channels don't have a loadcontext, check the global tracking
91 // protection preference.
92 if (!StaticPrefs::privacy_trackingprotection_enabled() &&
93 !(NS_UsePrivateBrowsing(aChannel
) &&
94 StaticPrefs::privacy_trackingprotection_pbmode_enabled())) {
97 } else if (!loadContext
->UseTrackingProtection()) {
101 bool isThirdParty
= AntiTrackingUtils::IsThirdPartyChannel(aChannel
);
104 ("UrlClassifierFeatureTrackingProtection::MaybeCreate - "
105 "skipping first party or top-level load for channel %p",
110 if (!UrlClassifierCommon::ShouldEnableProtectionForChannel(aChannel
)) {
115 MOZ_ASSERT(gFeatureTrackingProtection
);
117 RefPtr
<UrlClassifierFeatureTrackingProtection
> self
=
118 gFeatureTrackingProtection
;
119 return self
.forget();
123 already_AddRefed
<nsIUrlClassifierFeature
>
124 UrlClassifierFeatureTrackingProtection::GetIfNameMatches(
125 const nsACString
& aName
) {
126 if (!aName
.EqualsLiteral(TRACKING_PROTECTION_FEATURE_NAME
)) {
131 MOZ_ASSERT(gFeatureTrackingProtection
);
133 RefPtr
<UrlClassifierFeatureTrackingProtection
> self
=
134 gFeatureTrackingProtection
;
135 return self
.forget();
139 UrlClassifierFeatureTrackingProtection::ProcessChannel(
140 nsIChannel
* aChannel
, const nsTArray
<nsCString
>& aList
,
141 const nsTArray
<nsCString
>& aHashes
, bool* aShouldContinue
) {
142 NS_ENSURE_ARG_POINTER(aChannel
);
143 NS_ENSURE_ARG_POINTER(aShouldContinue
);
145 bool isAllowListed
= UrlClassifierCommon::IsAllowListed(aChannel
);
147 // This is a blocking feature.
148 *aShouldContinue
= isAllowListed
;
155 UrlClassifierCommon::TablesToString(aList
, list
);
157 ChannelBlockDecision decision
=
158 ChannelClassifierService::OnBeforeBlockChannel(aChannel
, mName
, list
);
159 if (decision
!= ChannelBlockDecision::Blocked
) {
161 decision
== ChannelBlockDecision::Replaced
162 ? nsIWebProgressListener::STATE_REPLACED_TRACKING_CONTENT
163 : nsIWebProgressListener::STATE_ALLOWED_TRACKING_CONTENT
;
164 ContentBlockingNotifier::OnEvent(aChannel
, event
, false);
166 *aShouldContinue
= true;
170 UrlClassifierCommon::SetBlockedContent(aChannel
, NS_ERROR_TRACKING_URI
, list
,
174 ("UrlClassifierFeatureTrackingProtection::ProcessChannel - "
175 "cancelling channel %p",
178 nsCOMPtr
<nsIHttpChannelInternal
> httpChannel
= do_QueryInterface(aChannel
);
180 Unused
<< httpChannel
->CancelByURLClassifier(NS_ERROR_TRACKING_URI
);
182 Unused
<< aChannel
->Cancel(NS_ERROR_TRACKING_URI
);
189 UrlClassifierFeatureTrackingProtection::GetURIByListType(
190 nsIChannel
* aChannel
, nsIUrlClassifierFeature::listType aListType
,
191 nsIUrlClassifierFeature::URIType
* aURIType
, nsIURI
** aURI
) {
192 NS_ENSURE_ARG_POINTER(aChannel
);
193 NS_ENSURE_ARG_POINTER(aURIType
);
194 NS_ENSURE_ARG_POINTER(aURI
);
196 if (aListType
== nsIUrlClassifierFeature::blocklist
) {
197 *aURIType
= nsIUrlClassifierFeature::blocklistURI
;
198 return aChannel
->GetURI(aURI
);
201 MOZ_ASSERT(aListType
== nsIUrlClassifierFeature::entitylist
);
203 *aURIType
= nsIUrlClassifierFeature::pairwiseEntitylistURI
;
204 return UrlClassifierCommon::CreatePairwiseEntityListURI(aChannel
, aURI
);
208 } // namespace mozilla