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