netwerk/cookie/Cookie.cpp

   1 /* -*- Mode: C++; tab-width: 4; 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 #include "Cookie.h"
   7 #include "CookieStorage.h"
   8 #include "mozilla/Encoding.h"
   9 #include "mozilla/dom/ToJSValue.h"
  10 #include "mozilla/glean/GleanMetrics.h"
  11 #include "mozilla/StaticPrefs_network.h"
  12 #include "nsIURLParser.h"
  13 #include "nsURLHelper.h"
  14 #include <cstdlib>
  15
  16 namespace mozilla {
  17 namespace net {
  18
  19 /******************************************************************************
  20  * Cookie:
  21  * creation helper
  22  ******************************************************************************/
  23
  24 // This is a counter that keeps track of the last used creation time, each time
  25 // we create a new Cookie. This is nominally the time (in microseconds) the
  26 // cookie was created, but is guaranteed to be monotonically increasing for
  27 // cookies added at runtime after the database has been read in. This is
  28 // necessary to enforce ordering among cookies whose creation times would
  29 // otherwise overlap, since it's possible two cookies may be created at the
  30 // same time, or that the system clock isn't monotonic.
  31 static int64_t gLastCreationTime;
  32
  33 int64_t Cookie::GenerateUniqueCreationTime(int64_t aCreationTime) {
  34   // Check if the creation time given to us is greater than the running maximum
  35   // (it should always be monotonically increasing).
  36   if (aCreationTime > gLastCreationTime) {
  37     gLastCreationTime = aCreationTime;
  38     return aCreationTime;
  39   }
  40
  41   // Make up our own.
  42   return ++gLastCreationTime;
  43 }
  44
  45 already_AddRefed<Cookie> Cookie::Create(
  46     const CookieStruct& aCookieData,
  47     const OriginAttributes& aOriginAttributes) {
  48   RefPtr<Cookie> cookie =
  49       Cookie::FromCookieStruct(aCookieData, aOriginAttributes);
  50
  51   // If the creationTime given to us is higher than the running maximum,
  52   // update our maximum.
  53   if (cookie->mData.creationTime() > gLastCreationTime) {
  54     gLastCreationTime = cookie->mData.creationTime();
  55   }
  56
  57   return cookie.forget();
  58 }
  59
  60 already_AddRefed<Cookie> Cookie::FromCookieStruct(
  61     const CookieStruct& aCookieData,
  62     const OriginAttributes& aOriginAttributes) {
  63   RefPtr<Cookie> cookie = new Cookie(aCookieData, aOriginAttributes);
  64
  65   // Ensure mValue contains a valid UTF-8 sequence. Otherwise XPConnect will
  66   // truncate the string after the first invalid octet.
  67   UTF_8_ENCODING->DecodeWithoutBOMHandling(aCookieData.value(),
  68                                            cookie->mData.value());
  69
  70   // If sameSite/rawSameSite values aren't sensible reset to Default
  71   // cf. 5.4.7 in draft-ietf-httpbis-rfc6265bis-09
  72   if (!Cookie::ValidateSameSite(cookie->mData)) {
  73     cookie->mData.sameSite() = nsICookie::SAMESITE_LAX;
  74     cookie->mData.rawSameSite() = nsICookie::SAMESITE_NONE;
  75   }
  76
  77   return cookie.forget();
  78 }
  79
  80 already_AddRefed<Cookie> Cookie::CreateValidated(
  81     const CookieStruct& aCookieData,
  82     const OriginAttributes& aOriginAttributes) {
  83   if (!StaticPrefs::network_cookie_fixup_on_db_load()) {
  84     return Cookie::Create(aCookieData, aOriginAttributes);
  85   }
  86
  87   RefPtr<Cookie> cookie =
  88       Cookie::FromCookieStruct(aCookieData, aOriginAttributes);
  89
  90   int64_t currentTimeInUsec = PR_Now();
  91   // Assert that the last creation time is not higher than the current time.
  92   // The 10000 wiggle room accounts for the fact that calling
  93   // GenerateUniqueCreationTime might go over the value of PR_Now(), but we'd
  94   // most likely not add 10000 cookies in a row.
  95   MOZ_ASSERT(gLastCreationTime < currentTimeInUsec + 10000,
  96              "Last creation time must not be higher than NOW");
  97
  98   // If the creationTime given to us is higher than the current time then
  99   // update the creation time to now.
 100   if (cookie->mData.creationTime() > currentTimeInUsec) {
 101     uint64_t diffInSeconds =
 102         (cookie->mData.creationTime() - currentTimeInUsec) / PR_USEC_PER_SEC;
 103     mozilla::glean::networking::cookie_creation_fixup_diff
 104         .AccumulateSingleSample(diffInSeconds);
 105     glean::networking::cookie_timestamp_fixed_count.Get("creationTime"_ns)
 106         .Add(1);
 107
 108     cookie->mData.creationTime() =
 109         GenerateUniqueCreationTime(currentTimeInUsec);
 110   }
 111
 112   if (cookie->mData.lastAccessed() > currentTimeInUsec) {
 113     uint64_t diffInSeconds =
 114         (cookie->mData.lastAccessed() - currentTimeInUsec) / PR_USEC_PER_SEC;
 115     mozilla::glean::networking::cookie_access_fixup_diff.AccumulateSingleSample(
 116         diffInSeconds);
 117     glean::networking::cookie_timestamp_fixed_count.Get("lastAccessed"_ns)
 118         .Add(1);
 119
 120     cookie->mData.lastAccessed() = currentTimeInUsec;
 121   }
 122
 123   return cookie.forget();
 124 }
 125
 126 size_t Cookie::SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const {
 127   return aMallocSizeOf(this) +
 128          mData.name().SizeOfExcludingThisIfUnshared(MallocSizeOf) +
 129          mData.value().SizeOfExcludingThisIfUnshared(MallocSizeOf) +
 130          mData.host().SizeOfExcludingThisIfUnshared(MallocSizeOf) +
 131          mData.path().SizeOfExcludingThisIfUnshared(MallocSizeOf) +
 132          mFilePathCache.SizeOfExcludingThisIfUnshared(MallocSizeOf);
 133 }
 134
 135 bool Cookie::IsStale() const {
 136   int64_t currentTimeInUsec = PR_Now();
 137
 138   return currentTimeInUsec - LastAccessed() >
 139          StaticPrefs::network_cookie_staleThreshold() * PR_USEC_PER_SEC;
 140 }
 141
 142 /******************************************************************************
 143  * Cookie:
 144  * xpcom impl
 145  ******************************************************************************/
 146
 147 // xpcom getters
 148 NS_IMETHODIMP Cookie::GetName(nsACString& aName) {
 149   aName = Name();
 150   return NS_OK;
 151 }
 152 NS_IMETHODIMP Cookie::GetValue(nsACString& aValue) {
 153   aValue = Value();
 154   return NS_OK;
 155 }
 156 NS_IMETHODIMP Cookie::GetHost(nsACString& aHost) {
 157   aHost = Host();
 158   return NS_OK;
 159 }
 160 NS_IMETHODIMP Cookie::GetRawHost(nsACString& aHost) {
 161   aHost = RawHost();
 162   return NS_OK;
 163 }
 164 NS_IMETHODIMP Cookie::GetPath(nsACString& aPath) {
 165   aPath = Path();
 166   return NS_OK;
 167 }
 168 NS_IMETHODIMP Cookie::GetExpiry(int64_t* aExpiry) {
 169   *aExpiry = Expiry();
 170   return NS_OK;
 171 }
 172 NS_IMETHODIMP Cookie::GetIsSession(bool* aIsSession) {
 173   *aIsSession = IsSession();
 174   return NS_OK;
 175 }
 176 NS_IMETHODIMP Cookie::GetIsDomain(bool* aIsDomain) {
 177   *aIsDomain = IsDomain();
 178   return NS_OK;
 179 }
 180 NS_IMETHODIMP Cookie::GetIsSecure(bool* aIsSecure) {
 181   *aIsSecure = IsSecure();
 182   return NS_OK;
 183 }
 184 NS_IMETHODIMP Cookie::GetIsHttpOnly(bool* aHttpOnly) {
 185   *aHttpOnly = IsHttpOnly();
 186   return NS_OK;
 187 }
 188 NS_IMETHODIMP Cookie::GetIsPartitioned(bool* aPartitioned) {
 189   *aPartitioned = IsPartitioned();
 190   return NS_OK;
 191 }
 192 NS_IMETHODIMP Cookie::GetCreationTime(int64_t* aCreation) {
 193   *aCreation = CreationTime();
 194   return NS_OK;
 195 }
 196 NS_IMETHODIMP Cookie::GetLastAccessed(int64_t* aTime) {
 197   *aTime = LastAccessed();
 198   return NS_OK;
 199 }
 200 NS_IMETHODIMP Cookie::GetSameSite(int32_t* aSameSite) {
 201   if (StaticPrefs::network_cookie_sameSite_laxByDefault()) {
 202     *aSameSite = SameSite();
 203   } else {
 204     *aSameSite = RawSameSite();
 205   }
 206   return NS_OK;
 207 }
 208 NS_IMETHODIMP Cookie::GetSchemeMap(nsICookie::schemeType* aSchemeMap) {
 209   *aSchemeMap = static_cast<nsICookie::schemeType>(SchemeMap());
 210   return NS_OK;
 211 }
 212
 213 NS_IMETHODIMP
 214 Cookie::GetOriginAttributes(JSContext* aCx, JS::MutableHandle<JS::Value> aVal) {
 215   if (NS_WARN_IF(!ToJSValue(aCx, mOriginAttributes, aVal))) {
 216     return NS_ERROR_FAILURE;
 217   }
 218   return NS_OK;
 219 }
 220
 221 const OriginAttributes& Cookie::OriginAttributesNative() {
 222   return mOriginAttributes;
 223 }
 224
 225 const Cookie& Cookie::AsCookie() { return *this; }
 226
 227 const nsCString& Cookie::GetFilePath() {
 228   MOZ_DIAGNOSTIC_ASSERT(NS_IsMainThread());
 229
 230   if (Path().IsEmpty()) {
 231     // If we don't have a path, just return the (empty) file path cache.
 232     return mFilePathCache;
 233   }
 234   if (!mFilePathCache.IsEmpty()) {
 235     // If we've computed the answer before, just return it.
 236     return mFilePathCache;
 237   }
 238
 239   nsIURLParser* parser = net_GetStdURLParser();
 240   NS_ENSURE_TRUE(parser, mFilePathCache);
 241
 242   int32_t pathLen = Path().Length();
 243   int32_t filepathLen = 0;
 244   uint32_t filepathPos = 0;
 245
 246   nsresult rv = parser->ParsePath(PromiseFlatCString(Path()).get(), pathLen,
 247                                   &filepathPos, &filepathLen, nullptr,
 248                                   nullptr,            // don't care about query
 249                                   nullptr, nullptr);  // don't care about ref
 250   NS_ENSURE_SUCCESS(rv, mFilePathCache);
 251
 252   mFilePathCache = Substring(Path(), filepathPos, filepathLen);
 253
 254   return mFilePathCache;
 255 }
 256
 257 // compatibility method, for use with the legacy nsICookie interface.
 258 // here, expires == 0 denotes a session cookie.
 259 NS_IMETHODIMP
 260 Cookie::GetExpires(uint64_t* aExpires) {
 261   if (IsSession()) {
 262     *aExpires = 0;
 263   } else {
 264     *aExpires = Expiry() > 0 ? Expiry() : 1;
 265   }
 266   return NS_OK;
 267 }
 268
 269 // static
 270 bool Cookie::ValidateSameSite(const CookieStruct& aCookieData) {
 271   // For proper migration towards a laxByDefault world,
 272   // sameSite is initialized to LAX even though the server
 273   // has never sent it.
 274   if (aCookieData.rawSameSite() == aCookieData.sameSite()) {
 275     return aCookieData.rawSameSite() >= nsICookie::SAMESITE_NONE &&
 276            aCookieData.rawSameSite() <= nsICookie::SAMESITE_STRICT;
 277   }
 278   return aCookieData.rawSameSite() == nsICookie::SAMESITE_NONE &&
 279          aCookieData.sameSite() == nsICookie::SAMESITE_LAX;
 280 }
 281
 282 already_AddRefed<Cookie> Cookie::Clone() const {
 283   return Create(mData, OriginAttributesRef());
 284 }
 285
 286 NS_IMPL_ISUPPORTS(Cookie, nsICookie)
 287
 288 }  // namespace net
 289 }  // namespace mozilla