caps/OriginAttributes.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_OriginAttributes_h
   8 #define mozilla_OriginAttributes_h
   9
  10 #include "mozilla/dom/ChromeUtilsBinding.h"
  11 #include "mozilla/StaticPrefs_privacy.h"
  12 #include "nsIScriptSecurityManager.h"
  13
  14 namespace mozilla {
  15
  16 class OriginAttributes : public dom::OriginAttributesDictionary {
  17  public:
  18   OriginAttributes() = default;
  19
  20   explicit OriginAttributes(bool aInIsolatedMozBrowser) {
  21     mInIsolatedMozBrowser = aInIsolatedMozBrowser;
  22   }
  23
  24   explicit OriginAttributes(const OriginAttributesDictionary& aOther)
  25       : OriginAttributesDictionary(aOther) {}
  26
  27   void SetFirstPartyDomain(const bool aIsTopLevelDocument, nsIURI* aURI,
  28                            bool aForced = false);
  29   void SetFirstPartyDomain(const bool aIsTopLevelDocument,
  30                            const nsACString& aDomain);
  31   void SetFirstPartyDomain(const bool aIsTopLevelDocument,
  32                            const nsAString& aDomain, bool aForced = false);
  33
  34   void SetPartitionKey(nsIURI* aURI);
  35   void SetPartitionKey(const nsACString& aDomain);
  36   void SetPartitionKey(const nsAString& aDomain);
  37
  38   enum {
  39     STRIP_FIRST_PARTY_DOMAIN = 0x01,
  40     STRIP_USER_CONTEXT_ID = 0x02,
  41     STRIP_PRIVATE_BROWSING_ID = 0x04,
  42     STRIP_PARITION_KEY = 0x08,
  43   };
  44
  45   inline void StripAttributes(uint32_t aFlags) {
  46     if (aFlags & STRIP_FIRST_PARTY_DOMAIN) {
  47       mFirstPartyDomain.Truncate();
  48     }
  49
  50     if (aFlags & STRIP_USER_CONTEXT_ID) {
  51       mUserContextId = nsIScriptSecurityManager::DEFAULT_USER_CONTEXT_ID;
  52     }
  53
  54     if (aFlags & STRIP_PRIVATE_BROWSING_ID) {
  55       mPrivateBrowsingId =
  56           nsIScriptSecurityManager::DEFAULT_PRIVATE_BROWSING_ID;
  57     }
  58
  59     if (aFlags & STRIP_PARITION_KEY) {
  60       mPartitionKey.Truncate();
  61     }
  62   }
  63
  64   bool operator==(const OriginAttributes& aOther) const {
  65     return EqualsIgnoringFPD(aOther) &&
  66            mFirstPartyDomain == aOther.mFirstPartyDomain &&
  67            // FIXME(emilio, bug 1667440): Should this be part of
  68            // EqualsIgnoringFPD instead?
  69            mPartitionKey == aOther.mPartitionKey;
  70   }
  71
  72   bool operator!=(const OriginAttributes& aOther) const {
  73     return !(*this == aOther);
  74   }
  75
  76   [[nodiscard]] bool EqualsIgnoringFPD(const OriginAttributes& aOther) const {
  77     return mInIsolatedMozBrowser == aOther.mInIsolatedMozBrowser &&
  78            mUserContextId == aOther.mUserContextId &&
  79            mPrivateBrowsingId == aOther.mPrivateBrowsingId &&
  80            mGeckoViewSessionContextId == aOther.mGeckoViewSessionContextId;
  81   }
  82
  83   [[nodiscard]] bool EqualsIgnoringPartitionKey(
  84       const OriginAttributes& aOther) const {
  85     return EqualsIgnoringFPD(aOther) &&
  86            mFirstPartyDomain == aOther.mFirstPartyDomain;
  87   }
  88
  89   // Serializes/Deserializes non-default values into the suffix format, i.e.
  90   // |^key1=value1&key2=value2|. If there are no non-default attributes, this
  91   // returns an empty string.
  92   void CreateSuffix(nsACString& aStr) const;
  93
  94   // Like CreateSuffix, but returns an atom instead of producing a string.
  95   already_AddRefed<nsAtom> CreateSuffixAtom() const;
  96
  97   // Don't use this method for anything else than debugging!
  98   void CreateAnonymizedSuffix(nsACString& aStr) const;
  99
 100   [[nodiscard]] bool PopulateFromSuffix(const nsACString& aStr);
 101
 102   // Populates the attributes from a string like
 103   // |uri^key1=value1&key2=value2| and returns the uri without the suffix.
 104   [[nodiscard]] bool PopulateFromOrigin(const nsACString& aOrigin,
 105                                         nsACString& aOriginNoSuffix);
 106
 107   // Helper function to match mIsPrivateBrowsing to existing private browsing
 108   // flags. Once all other flags are removed, this can be removed too.
 109   void SyncAttributesWithPrivateBrowsing(bool aInPrivateBrowsing);
 110
 111   // check if "privacy.firstparty.isolate" is enabled.
 112   static inline bool IsFirstPartyEnabled() {
 113     return StaticPrefs::privacy_firstparty_isolate();
 114   }
 115
 116   static inline bool UseSiteForFirstPartyDomain() {
 117     if (IsFirstPartyEnabled()) {
 118       return StaticPrefs::privacy_firstparty_isolate_use_site();
 119     }
 120     return StaticPrefs::privacy_dynamic_firstparty_use_site();
 121   }
 122
 123   // check if the access of window.opener across different FPDs is restricted.
 124   // We only restrict the access of window.opener when first party isolation
 125   // is enabled and "privacy.firstparty.isolate.restrict_opener_access" is on.
 126   static inline bool IsRestrictOpenerAccessForFPI() {
 127     // We always want to restrict window.opener if first party isolation is
 128     // disabled.
 129     return !StaticPrefs::privacy_firstparty_isolate() ||
 130            StaticPrefs::privacy_firstparty_isolate_restrict_opener_access();
 131   }
 132
 133   // Check whether we block the postMessage across different FPDs when the
 134   // targetOrigin is '*'.
 135   [[nodiscard]] static inline bool IsBlockPostMessageForFPI() {
 136     return StaticPrefs::privacy_firstparty_isolate() &&
 137            StaticPrefs::privacy_firstparty_isolate_block_post_message();
 138   }
 139
 140   // returns true if the originAttributes suffix has mPrivateBrowsingId value
 141   // different than 0.
 142   static bool IsPrivateBrowsing(const nsACString& aOrigin);
 143
 144   // Parse a partitionKey of the format "(<scheme>,<baseDomain>,[port])" into
 145   // its components.
 146   // Returns false if the partitionKey cannot be parsed because the format is
 147   // invalid.
 148   static bool ParsePartitionKey(const nsAString& aPartitionKey,
 149                                 nsAString& outScheme, nsAString& outBaseDomain,
 150                                 int32_t& outPort);
 151 };
 152
 153 class OriginAttributesPattern : public dom::OriginAttributesPatternDictionary {
 154  public:
 155   // To convert a JSON string to an OriginAttributesPattern, do the following:
 156   //
 157   // OriginAttributesPattern pattern;
 158   // if (!pattern.Init(aJSONString)) {
 159   //   ... // handle failure.
 160   // }
 161   OriginAttributesPattern() = default;
 162
 163   explicit OriginAttributesPattern(
 164       const OriginAttributesPatternDictionary& aOther)
 165       : OriginAttributesPatternDictionary(aOther) {}
 166
 167   // Performs a match of |aAttrs| against this pattern.
 168   bool Matches(const OriginAttributes& aAttrs) const {
 169     if (mInIsolatedMozBrowser.WasPassed() &&
 170         mInIsolatedMozBrowser.Value() != aAttrs.mInIsolatedMozBrowser) {
 171       return false;
 172     }
 173
 174     if (mUserContextId.WasPassed() &&
 175         mUserContextId.Value() != aAttrs.mUserContextId) {
 176       return false;
 177     }
 178
 179     if (mPrivateBrowsingId.WasPassed() &&
 180         mPrivateBrowsingId.Value() != aAttrs.mPrivateBrowsingId) {
 181       return false;
 182     }
 183
 184     if (mFirstPartyDomain.WasPassed() &&
 185         mFirstPartyDomain.Value() != aAttrs.mFirstPartyDomain) {
 186       return false;
 187     }
 188
 189     if (mGeckoViewSessionContextId.WasPassed() &&
 190         mGeckoViewSessionContextId.Value() !=
 191             aAttrs.mGeckoViewSessionContextId) {
 192       return false;
 193     }
 194
 195     // If both mPartitionKey and mPartitionKeyPattern are passed, mPartitionKey
 196     // takes precedence.
 197     if (mPartitionKey.WasPassed()) {
 198       if (mPartitionKey.Value() != aAttrs.mPartitionKey) {
 199         return false;
 200       }
 201     } else if (mPartitionKeyPattern.WasPassed()) {
 202       auto& pkPattern = mPartitionKeyPattern.Value();
 203
 204       if (pkPattern.mScheme.WasPassed() || pkPattern.mBaseDomain.WasPassed() ||
 205           pkPattern.mPort.WasPassed()) {
 206         if (aAttrs.mPartitionKey.IsEmpty()) {
 207           return false;
 208         }
 209
 210         nsString scheme;
 211         nsString baseDomain;
 212         int32_t port;
 213         bool success = OriginAttributes::ParsePartitionKey(
 214             aAttrs.mPartitionKey, scheme, baseDomain, port);
 215         if (!success) {
 216           return false;
 217         }
 218
 219         if (pkPattern.mScheme.WasPassed() &&
 220             pkPattern.mScheme.Value() != scheme) {
 221           return false;
 222         }
 223         if (pkPattern.mBaseDomain.WasPassed() &&
 224             pkPattern.mBaseDomain.Value() != baseDomain) {
 225           return false;
 226         }
 227         if (pkPattern.mPort.WasPassed() && pkPattern.mPort.Value() != port) {
 228           return false;
 229         }
 230       }
 231     }
 232
 233     return true;
 234   }
 235
 236   bool Overlaps(const OriginAttributesPattern& aOther) const {
 237     if (mInIsolatedMozBrowser.WasPassed() &&
 238         aOther.mInIsolatedMozBrowser.WasPassed() &&
 239         mInIsolatedMozBrowser.Value() != aOther.mInIsolatedMozBrowser.Value()) {
 240       return false;
 241     }
 242
 243     if (mUserContextId.WasPassed() && aOther.mUserContextId.WasPassed() &&
 244         mUserContextId.Value() != aOther.mUserContextId.Value()) {
 245       return false;
 246     }
 247
 248     if (mPrivateBrowsingId.WasPassed() &&
 249         aOther.mPrivateBrowsingId.WasPassed() &&
 250         mPrivateBrowsingId.Value() != aOther.mPrivateBrowsingId.Value()) {
 251       return false;
 252     }
 253
 254     if (mFirstPartyDomain.WasPassed() && aOther.mFirstPartyDomain.WasPassed() &&
 255         mFirstPartyDomain.Value() != aOther.mFirstPartyDomain.Value()) {
 256       return false;
 257     }
 258
 259     if (mGeckoViewSessionContextId.WasPassed() &&
 260         aOther.mGeckoViewSessionContextId.WasPassed() &&
 261         mGeckoViewSessionContextId.Value() !=
 262             aOther.mGeckoViewSessionContextId.Value()) {
 263       return false;
 264     }
 265
 266     if (mPartitionKey.WasPassed() && aOther.mPartitionKey.WasPassed() &&
 267         mPartitionKey.Value() != aOther.mPartitionKey.Value()) {
 268       return false;
 269     }
 270
 271     if (mPartitionKeyPattern.WasPassed() &&
 272         aOther.mPartitionKeyPattern.WasPassed()) {
 273       auto& self = mPartitionKeyPattern.Value();
 274       auto& other = aOther.mPartitionKeyPattern.Value();
 275
 276       if (self.mScheme.WasPassed() && other.mScheme.WasPassed() &&
 277           self.mScheme.Value() != other.mScheme.Value()) {
 278         return false;
 279       }
 280       if (self.mBaseDomain.WasPassed() && other.mBaseDomain.WasPassed() &&
 281           self.mBaseDomain.Value() != other.mBaseDomain.Value()) {
 282         return false;
 283       }
 284       if (self.mPort.WasPassed() && other.mPort.WasPassed() &&
 285           self.mPort.Value() != other.mPort.Value()) {
 286         return false;
 287       }
 288     }
 289
 290     return true;
 291   }
 292 };
 293
 294 }  // namespace mozilla
 295
 296 #endif /* mozilla_OriginAttributes_h */