toolkit/components/antitracking/bouncetrackingprotection/BounceTrackingRecord.h

   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/. */
   6
   7 #ifndef mozilla_BounceTrackingRecord_h
   8 #define mozilla_BounceTrackingRecord_h
   9
  10 #include "nsStringFwd.h"
  11 #include "nsTHashSet.h"
  12
  13 namespace mozilla {
  14
  15 namespace dom {
  16 class CanonicalBrowsingContext;
  17 }
  18
  19 // Stores per-tab data relevant to bounce tracking protection for every extended
  20 // navigation.
  21 class BounceTrackingRecord final {
  22  public:
  23   void SetInitialHost(const nsACString& aHost);
  24
  25   const nsACString& GetInitialHost() const;
  26
  27   void SetFinalHost(const nsACString& aHost);
  28
  29   const nsACString& GetFinalHost() const;
  30
  31   void AddBounceHost(const nsACString& aHost);
  32
  33   void AddStorageAccessHost(const nsACString& aHost);
  34
  35   void AddUserActivationHost(const nsACString& aHost);
  36
  37   const nsTHashSet<nsCStringHashKey>& GetBounceHosts() const;
  38
  39   const nsTHashSet<nsCStringHashKey>& GetStorageAccessHosts() const;
  40
  41   const nsTHashSet<nsCStringHashKey>& GetUserActivationHosts() const;
  42
  43   // Create a string that describes this record. Used for logging.
  44   nsCString Describe();
  45
  46  private:
  47   // A site's host. The initiator site of the current extended navigation.
  48   nsAutoCString mInitialHost;
  49
  50   // A site's host or null. The destination of the current extended navigation.
  51   // Updated after every document load.
  52   nsAutoCString mFinalHost;
  53
  54   // A set of sites' hosts. All server-side and client-side redirects hit during
  55   // this extended navigation.
  56   nsTHashSet<nsCStringHashKey> mBounceHosts;
  57
  58   // A set of sites' hosts. All sites which accessed storage during this
  59   // extended navigation.
  60   nsTHashSet<nsCStringHashKey> mStorageAccessHosts;
  61
  62   // A set of sites' hosts. All sites which received user activation during
  63   // this extended navigation.
  64   // This is not used by bounce tracking protection itself, but are instead
  65   // used to enable storage access heuristics. See Bug 1935235.
  66   nsTHashSet<nsCStringHashKey> mUserActivationHosts;
  67
  68   // Create a comma-delimited string that describes a string set. Used for
  69   // logging.
  70   static nsCString DescribeSet(const nsTHashSet<nsCStringHashKey>& set);
  71 };
  72
  73 }  // namespace mozilla
  74
  75 #endif