summaryrefslogtreecommitdiffstats
path: root/toolkit/components/antitracking/ContentBlockingNotifier.h
blob: e7f7c622db26ea0990629fcb0241dcd704e878fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_contentblockingnotifier_h
#define mozilla_contentblockingnotifier_h

#include "nsStringFwd.h"
#include "mozilla/Maybe.h"

#define ANTITRACKING_CONSOLE_CATEGORY "Content Blocking"_ns

class nsIChannel;
class nsPIDOMWindowInner;
class nsPIDOMWindowOuter;

namespace mozilla {
namespace dom {
class BrowsingContext;
}  // namespace dom

class ContentBlockingNotifier final {
 public:
  enum class BlockingDecision {
    eBlock,
    eAllow,
  };
  enum StorageAccessPermissionGrantedReason {
    eStorageAccessAPI,
    eOpenerAfterUserInteraction,
    eOpener,
    ePrivilegeStorageAccessForOriginAPI,
  };

  // We try to classify observed canvas fingerprinting scripts into different
  // classes, but we don't usually know the source/vendor of those scripts. The
  // classification is based on a behavioral analysis, based on type of canvas,
  // the extracted (e.g. toDataURL) size, the usage of functions like fillText
  // etc. See `nsRFPService::MaybeReportCanvasFingerprinter` for the
  // classification heuristic.
  enum CanvasFingerprinter {
    // Suspected fingerprint.com (FingerprintJS)
    eFingerprintJS,
    // Suspected Akamai fingerprinter
    eAkamai,
    // Unknown but distinct types of fingerprinters
    eVariant1,
    eVariant2,
    eVariant3,
    eVariant4,
    // This just indicates that more than one canvas was extracted and is a
    // very weak signal.
    eMaybe
  };

  // This method can be called on the parent process or on the content process.
  // The notification is propagated to the child channel if aChannel is a parent
  // channel proxy.
  //
  // aDecision can be eBlock if we have decided to block some content, or eAllow
  // if we have decided to allow the content through.
  //
  // aRejectedReason must be one of these values:
  //  * nsIWebProgressListener::STATE_COOKIES_BLOCKED_BY_PERMISSION
  //  * nsIWebProgressListener::STATE_COOKIES_BLOCKED_TRACKER
  //  * nsIWebProgressListener::STATE_COOKIES_BLOCKED_SOCIALTRACKER
  //  * nsIWebProgressListener::STATE_COOKIES_BLOCKED_ALL
  //  * nsIWebProgressListener::STATE_COOKIES_BLOCKED_FOREIGN
  static void OnDecision(nsIChannel* aChannel, BlockingDecision aDecision,
                         uint32_t aRejectedReason);

  static void OnDecision(nsPIDOMWindowInner* aWindow,
                         BlockingDecision aDecision, uint32_t aRejectedReason);

  static void OnDecision(dom::BrowsingContext* aBrowsingContext,
                         BlockingDecision aDecision, uint32_t aRejectedReason);

  static void OnEvent(nsIChannel* aChannel, uint32_t aRejectedReason,
                      bool aBlocked = true);

  static void OnEvent(
      nsIChannel* aChannel, bool aBlocked, uint32_t aRejectedReason,
      const nsACString& aTrackingOrigin,
      const ::mozilla::Maybe<StorageAccessPermissionGrantedReason>& aReason =
          Nothing(),
      const Maybe<CanvasFingerprinter>& aCanvasFingerprinter = Nothing(),
      const Maybe<bool> aCanvasFingerprinterKnownText = Nothing());

  static void ReportUnblockingToConsole(
      dom::BrowsingContext* aBrowsingContext, const nsAString& aTrackingOrigin,
      StorageAccessPermissionGrantedReason aReason);
};

}  // namespace mozilla

#endif  // mozilla_contentblockingnotifier_h