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 "UrlClassifierFeatureFingerprintingAnnotation.h"
9 #include "mozilla/net/UrlClassifierCommon.h"
10 #include "nsIClassifiedChannel.h"
11 #include "nsContentUtils.h"
12 #include "nsNetUtil.h"
13 #include "mozilla/StaticPtr.h"
14 #include "nsIWebProgressListener.h"
15 #include "nsIChannel.h"
22 #define FINGERPRINTING_ANNOTATION_FEATURE_NAME "fingerprinting-annotation"
24 #define URLCLASSIFIER_FINGERPRINTING_ANNOTATION_BLOCKLIST \
25 "urlclassifier.features.fingerprinting.annotate.blacklistTables"
26 #define URLCLASSIFIER_FINGERPRINTING_ANNOTATION_BLOCKLIST_TEST_ENTRIES \
27 "urlclassifier.features.fingerprinting.annotate.blacklistHosts"
28 #define URLCLASSIFIER_FINGERPRINTING_ANNOTATION_ENTITYLIST \
29 "urlclassifier.features.fingerprinting.annotate.whitelistTables"
30 #define URLCLASSIFIER_FINGERPRINTING_ANNOTATION_ENTITYLIST_TEST_ENTRIES \
31 "urlclassifier.features.fingerprinting.annotate.whitelistHosts"
32 #define URLCLASSIFIER_FINGERPRINTING_ANNOTATION_EXCEPTION_URLS \
33 "urlclassifier.features.fingerprinting.annotate.skipURLs"
34 #define TABLE_FINGERPRINTING_ANNOTATION_BLOCKLIST_PREF \
35 "fingerprinting-annotate-blacklist-pref"
36 #define TABLE_FINGERPRINTING_ANNOTATION_ENTITYLIST_PREF \
37 "fingerprinting-annotate-whitelist-pref"
39 StaticRefPtr
<UrlClassifierFeatureFingerprintingAnnotation
>
40 gFeatureFingerprintingAnnotation
;
44 UrlClassifierFeatureFingerprintingAnnotation::
45 UrlClassifierFeatureFingerprintingAnnotation()
46 : UrlClassifierFeatureAntiTrackingBase(
47 nsLiteralCString(FINGERPRINTING_ANNOTATION_FEATURE_NAME
),
48 nsLiteralCString(URLCLASSIFIER_FINGERPRINTING_ANNOTATION_BLOCKLIST
),
49 nsLiteralCString(URLCLASSIFIER_FINGERPRINTING_ANNOTATION_ENTITYLIST
),
51 URLCLASSIFIER_FINGERPRINTING_ANNOTATION_BLOCKLIST_TEST_ENTRIES
),
53 URLCLASSIFIER_FINGERPRINTING_ANNOTATION_ENTITYLIST_TEST_ENTRIES
),
54 nsLiteralCString(TABLE_FINGERPRINTING_ANNOTATION_BLOCKLIST_PREF
),
55 nsLiteralCString(TABLE_FINGERPRINTING_ANNOTATION_ENTITYLIST_PREF
),
57 URLCLASSIFIER_FINGERPRINTING_ANNOTATION_EXCEPTION_URLS
)) {}
59 /* static */ const char* UrlClassifierFeatureFingerprintingAnnotation::Name() {
60 return FINGERPRINTING_ANNOTATION_FEATURE_NAME
;
64 void UrlClassifierFeatureFingerprintingAnnotation::MaybeInitialize() {
66 ("UrlClassifierFeatureFingerprintingAnnotation::MaybeInitialize"));
68 if (!gFeatureFingerprintingAnnotation
) {
69 gFeatureFingerprintingAnnotation
=
70 new UrlClassifierFeatureFingerprintingAnnotation();
71 gFeatureFingerprintingAnnotation
->InitializePreferences();
76 void UrlClassifierFeatureFingerprintingAnnotation::MaybeShutdown() {
77 UC_LOG_LEAK(("UrlClassifierFeatureFingerprintingAnnotation::MaybeShutdown"));
79 if (gFeatureFingerprintingAnnotation
) {
80 gFeatureFingerprintingAnnotation
->ShutdownPreferences();
81 gFeatureFingerprintingAnnotation
= nullptr;
86 already_AddRefed
<UrlClassifierFeatureFingerprintingAnnotation
>
87 UrlClassifierFeatureFingerprintingAnnotation::MaybeCreate(
88 nsIChannel
* aChannel
) {
92 ("UrlClassifierFeatureFingerprintingAnnotation::MaybeCreate - channel %p",
95 if (UrlClassifierCommon::IsPassiveContent(aChannel
)) {
100 MOZ_ASSERT(gFeatureFingerprintingAnnotation
);
102 RefPtr
<UrlClassifierFeatureFingerprintingAnnotation
> self
=
103 gFeatureFingerprintingAnnotation
;
104 return self
.forget();
108 already_AddRefed
<nsIUrlClassifierFeature
>
109 UrlClassifierFeatureFingerprintingAnnotation::GetIfNameMatches(
110 const nsACString
& aName
) {
111 if (!aName
.EqualsLiteral(FINGERPRINTING_ANNOTATION_FEATURE_NAME
)) {
116 MOZ_ASSERT(gFeatureFingerprintingAnnotation
);
118 RefPtr
<UrlClassifierFeatureFingerprintingAnnotation
> self
=
119 gFeatureFingerprintingAnnotation
;
120 return self
.forget();
124 UrlClassifierFeatureFingerprintingAnnotation::ProcessChannel(
125 nsIChannel
* aChannel
, const nsTArray
<nsCString
>& aList
,
126 const nsTArray
<nsCString
>& aHashes
, bool* aShouldContinue
) {
127 NS_ENSURE_ARG_POINTER(aChannel
);
128 NS_ENSURE_ARG_POINTER(aShouldContinue
);
130 // This is not a blocking feature.
131 *aShouldContinue
= true;
134 ("UrlClassifierFeatureFingerprintingAnnotation::ProcessChannel - "
135 "annotating channel %p",
138 static std::vector
<UrlClassifierCommon::ClassificationData
>
139 sClassificationData
= {
140 {"content-fingerprinting-track-"_ns
,
141 nsIClassifiedChannel::ClassificationFlags::
142 CLASSIFIED_FINGERPRINTING_CONTENT
},
145 uint32_t flags
= UrlClassifierCommon::TablesToClassificationFlags(
146 aList
, sClassificationData
,
147 nsIClassifiedChannel::ClassificationFlags::CLASSIFIED_FINGERPRINTING
);
149 UrlClassifierCommon::SetTrackingInfo(aChannel
, aList
, aHashes
);
151 UrlClassifierCommon::AnnotateChannel(
153 nsIWebProgressListener::STATE_LOADED_FINGERPRINTING_CONTENT
);
159 UrlClassifierFeatureFingerprintingAnnotation::GetURIByListType(
160 nsIChannel
* aChannel
, nsIUrlClassifierFeature::listType aListType
,
161 nsIUrlClassifierFeature::URIType
* aURIType
, nsIURI
** aURI
) {
162 NS_ENSURE_ARG_POINTER(aChannel
);
163 NS_ENSURE_ARG_POINTER(aURIType
);
164 NS_ENSURE_ARG_POINTER(aURI
);
166 if (aListType
== nsIUrlClassifierFeature::blocklist
) {
167 *aURIType
= nsIUrlClassifierFeature::blocklistURI
;
168 return aChannel
->GetURI(aURI
);
171 MOZ_ASSERT(aListType
== nsIUrlClassifierFeature::entitylist
);
173 *aURIType
= nsIUrlClassifierFeature::pairwiseEntitylistURI
;
174 return UrlClassifierCommon::CreatePairwiseEntityListURI(aChannel
, aURI
);
178 } // namespace mozilla