netwerk/cookie/CookieService.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_net_CookieService_h
   7 #define mozilla_net_CookieService_h
   8
   9 #include "nsICookieService.h"
  10 #include "nsICookieManager.h"
  11 #include "nsIObserver.h"
  12 #include "nsWeakReference.h"
  13
  14 #include "Cookie.h"
  15 #include "CookieCommons.h"
  16
  17 #include "nsString.h"
  18 #include "nsIMemoryReporter.h"
  19 #include "mozilla/MemoryReporting.h"
  20
  21 class nsIConsoleReportCollector;
  22 class nsICookieJarSettings;
  23 class nsIEffectiveTLDService;
  24 class nsIIDNService;
  25 class nsIURI;
  26 class nsIChannel;
  27 class mozIThirdPartyUtil;
  28
  29 namespace mozilla {
  30 namespace net {
  31
  32 class CookiePersistentStorage;
  33 class CookiePrivateStorage;
  34 class CookieStorage;
  35
  36 /******************************************************************************
  37  * CookieService:
  38  * class declaration
  39  ******************************************************************************/
  40
  41 class CookieService final : public nsICookieService,
  42                             public nsICookieManager,
  43                             public nsIObserver,
  44                             public nsSupportsWeakReference,
  45                             public nsIMemoryReporter {
  46  private:
  47   size_t SizeOfIncludingThis(MallocSizeOf aMallocSizeOf) const;
  48
  49  public:
  50   NS_DECL_ISUPPORTS
  51   NS_DECL_NSIOBSERVER
  52   NS_DECL_NSICOOKIESERVICE
  53   NS_DECL_NSICOOKIEMANAGER
  54   NS_DECL_NSIMEMORYREPORTER
  55
  56   static already_AddRefed<CookieService> GetSingleton();
  57
  58   CookieService();
  59   static already_AddRefed<nsICookieService> GetXPCOMSingleton();
  60   nsresult Init();
  61
  62   /**
  63    * Start watching the observer service for messages indicating that an app has
  64    * been uninstalled.  When an app is uninstalled, we get the cookie service
  65    * (thus instantiating it, if necessary) and clear all the cookies for that
  66    * app.
  67    */
  68
  69   static bool CanSetCookie(nsIURI* aHostURI, const nsACString& aBaseDomain,
  70                            CookieStruct& aCookieData, bool aRequireHostMatch,
  71                            CookieStatus aStatus, nsCString& aCookieHeader,
  72                            bool aFromHttp, bool aIsForeignAndNotAddon,
  73                            bool aPartitionedOnly,
  74                            nsIConsoleReportCollector* aCRC, bool& aSetCookie);
  75   static CookieStatus CheckPrefs(
  76       nsIConsoleReportCollector* aCRC, nsICookieJarSettings* aCookieJarSettings,
  77       nsIURI* aHostURI, bool aIsForeign, bool aIsThirdPartyTrackingResource,
  78       bool aIsThirdPartySocialTrackingResource,
  79       bool aStorageAccessPermissionGranted, const nsACString& aCookieHeader,
  80       const int aNumOfCookies, const OriginAttributes& aOriginAttrs,
  81       uint32_t* aRejectedReason);
  82
  83   void GetCookiesForURI(nsIURI* aHostURI, nsIChannel* aChannel, bool aIsForeign,
  84                         bool aIsThirdPartyTrackingResource,
  85                         bool aIsThirdPartySocialTrackingResource,
  86                         bool aStorageAccessPermissionGranted,
  87                         uint32_t aRejectedReason, bool aIsSafeTopLevelNav,
  88                         bool aIsSameSiteForeign, bool aHadCrossSiteRedirects,
  89                         bool aHttpBound,
  90                         bool aAllowSecureCookiesToInsecureOrigin,
  91                         const OriginAttributes& aOriginAttrs,
  92                         nsTArray<Cookie*>& aCookieList);
  93
  94   /**
  95    * This method is a helper that allows calling nsICookieManager::Remove()
  96    * with OriginAttributes parameter.
  97    */
  98   nsresult Remove(const nsACString& aHost, const OriginAttributes& aAttrs,
  99                   const nsACString& aName, const nsACString& aPath);
 100
 101   bool SetCookiesFromIPC(const nsACString& aBaseDomain,
 102                          const OriginAttributes& aAttrs, nsIURI* aHostURI,
 103                          bool aFromHttp, const nsTArray<CookieStruct>& aCookies,
 104                          dom::BrowsingContext* aBrowsingContext);
 105
 106  protected:
 107   virtual ~CookieService();
 108
 109   bool IsInitialized() const;
 110
 111   void InitCookieStorages();
 112   void CloseCookieStorages();
 113
 114   nsresult NormalizeHost(nsCString& aHost);
 115   static bool GetTokenValue(nsACString::const_char_iterator& aIter,
 116                             nsACString::const_char_iterator& aEndIter,
 117                             nsDependentCSubstring& aTokenString,
 118                             nsDependentCSubstring& aTokenValue,
 119                             bool& aEqualsFound);
 120   static bool ParseAttributes(nsIConsoleReportCollector* aCRC, nsIURI* aHostURI,
 121                               nsCString& aCookieHeader,
 122                               CookieStruct& aCookieData, nsACString& aExpires,
 123                               nsACString& aMaxage, bool& aAcceptedByParser);
 124   static bool CheckDomain(CookieStruct& aCookieData, nsIURI* aHostURI,
 125                           const nsACString& aBaseDomain,
 126                           bool aRequireHostMatch);
 127   static bool CheckHiddenPrefix(CookieStruct& aCookieData);
 128   static bool CheckPath(CookieStruct& aCookieData,
 129                         nsIConsoleReportCollector* aCRC, nsIURI* aHostURI);
 130   static bool CheckPrefixes(CookieStruct& aCookieData, bool aSecureRequest);
 131   static bool GetExpiry(CookieStruct& aCookieData, const nsACString& aExpires,
 132                         const nsACString& aMaxage, int64_t aCurrentTime,
 133                         bool aFromHttp);
 134   void NotifyAccepted(nsIChannel* aChannel);
 135
 136   nsresult GetCookiesWithOriginAttributes(
 137       const OriginAttributesPattern& aPattern, const nsCString& aBaseDomain,
 138       nsTArray<RefPtr<nsICookie>>& aResult);
 139   nsresult RemoveCookiesWithOriginAttributes(
 140       const OriginAttributesPattern& aPattern, const nsCString& aBaseDomain);
 141
 142  protected:
 143   CookieStorage* PickStorage(const OriginAttributes& aAttrs);
 144   CookieStorage* PickStorage(const OriginAttributesPattern& aAttrs);
 145
 146   nsresult RemoveCookiesFromExactHost(const nsACString& aHost,
 147                                       const OriginAttributesPattern& aPattern);
 148
 149   // cached members.
 150   nsCOMPtr<mozIThirdPartyUtil> mThirdPartyUtil;
 151   nsCOMPtr<nsIEffectiveTLDService> mTLDService;
 152   nsCOMPtr<nsIIDNService> mIDNService;
 153
 154   // we have two separate Cookie Storages: one for normal browsing and one for
 155   // private browsing.
 156   RefPtr<CookieStorage> mPersistentStorage;
 157   RefPtr<CookieStorage> mPrivateStorage;
 158 };
 159
 160 }  // namespace net
 161 }  // namespace mozilla
 162
 163 #endif  // mozilla_net_CookieService_h