123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862 |
- // Copyright (c) 2012 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- // Brought to you by the letter D and the number 2.
- #ifndef NET_COOKIES_COOKIE_MONSTER_H_
- #define NET_COOKIES_COOKIE_MONSTER_H_
- #include <stddef.h>
- #include <stdint.h>
- #include <map>
- #include <memory>
- #include <set>
- #include <string>
- #include <vector>
- #include "base/callback_forward.h"
- #include "base/containers/circular_deque.h"
- #include "base/containers/flat_map.h"
- #include "base/gtest_prod_util.h"
- #include "base/memory/ref_counted.h"
- #include "base/memory/weak_ptr.h"
- #include "base/strings/string_piece.h"
- #include "base/threading/thread_checker.h"
- #include "base/time/time.h"
- #include "net/base/net_export.h"
- #include "net/base/schemeful_site.h"
- #include "net/cookies/canonical_cookie.h"
- #include "net/cookies/cookie_access_delegate.h"
- #include "net/cookies/cookie_constants.h"
- #include "net/cookies/cookie_inclusion_status.h"
- #include "net/cookies/cookie_monster_change_dispatcher.h"
- #include "net/cookies/cookie_store.h"
- #include "net/log/net_log_with_source.h"
- #include "third_party/abseil-cpp/absl/types/optional.h"
- #include "url/gurl.h"
- namespace net {
- class CookieChangeDispatcher;
- // The cookie monster is the system for storing and retrieving cookies. It has
- // an in-memory list of all cookies, and synchronizes non-session cookies to an
- // optional permanent storage that implements the PersistentCookieStore
- // interface.
- //
- // Tasks may be deferred if all affected cookies are not yet loaded from the
- // backing store. Otherwise, callbacks may be invoked immediately.
- //
- // A cookie task is either pending loading of the entire cookie store, or
- // loading of cookies for a specific domain key (GetKey(), roughly eTLD+1). In
- // the former case, the cookie callback will be queued in tasks_pending_ while
- // PersistentCookieStore chain loads the cookie store on DB thread. In the
- // latter case, the cookie callback will be queued in tasks_pending_for_key_
- // while PermanentCookieStore loads cookies for the specified domain key on DB
- // thread.
- class NET_EXPORT CookieMonster : public CookieStore {
- public:
- class PersistentCookieStore;
- // Terminology:
- // * The 'top level domain' (TLD) of an internet domain name is
- // the terminal "." free substring (e.g. "com" for google.com
- // or world.std.com).
- // * The 'effective top level domain' (eTLD) is the longest
- // "." initiated terminal substring of an internet domain name
- // that is controlled by a general domain registrar.
- // (e.g. "co.uk" for news.bbc.co.uk).
- // * The 'effective top level domain plus one' (eTLD+1) is the
- // shortest "." delimited terminal substring of an internet
- // domain name that is not controlled by a general domain
- // registrar (e.g. "bbc.co.uk" for news.bbc.co.uk, or
- // "google.com" for news.google.com). The general assumption
- // is that all hosts and domains under an eTLD+1 share some
- // administrative control.
- // CookieMap is the central data structure of the CookieMonster. It
- // is a map whose values are pointers to CanonicalCookie data
- // structures (the data structures are owned by the CookieMonster
- // and must be destroyed when removed from the map). The key is based on the
- // effective domain of the cookies. If the domain of the cookie has an
- // eTLD+1, that is the key for the map. If the domain of the cookie does not
- // have an eTLD+1, the key of the map is the host the cookie applies to (it is
- // not legal to have domain cookies without an eTLD+1). This rule
- // excludes cookies for, e.g, ".com", ".co.uk", or ".internalnetwork".
- // This behavior is the same as the behavior in Firefox v 3.6.10.
- // CookieMap does not store cookies that were set with the Partitioned
- // attribute, those are stored in PartitionedCookieMap.
- // NOTE(deanm):
- // I benchmarked hash_multimap vs multimap. We're going to be query-heavy
- // so it would seem like hashing would help. However they were very
- // close, with multimap being a tiny bit faster. I think this is because
- // our map is at max around 1000 entries, and the additional complexity
- // for the hashing might not overcome the O(log(1000)) for querying
- // a multimap. Also, multimap is standard, another reason to use it.
- // TODO(rdsmith): This benchmark should be re-done now that we're allowing
- // substantially more entries in the map.
- using CookieMap =
- std::multimap<std::string, std::unique_ptr<CanonicalCookie>>;
- using CookieMapItPair = std::pair<CookieMap::iterator, CookieMap::iterator>;
- using CookieItVector = std::vector<CookieMap::iterator>;
- // PartitionedCookieMap only stores cookies that were set with the Partitioned
- // attribute. The map is double-keyed on cookie's partition key and
- // the cookie's effective domain of the cookie (the key of CookieMap).
- // We store partitioned cookies in a separate map so that the queries for a
- // request's unpartitioned and partitioned cookies will both be more
- // efficient (since querying two smaller maps is more efficient that querying
- // one larger map twice).
- using PartitionedCookieMap =
- std::map<CookiePartitionKey, std::unique_ptr<CookieMap>>;
- using PartitionedCookieMapIterators =
- std::pair<PartitionedCookieMap::iterator, CookieMap::iterator>;
- // Cookie garbage collection thresholds. Based off of the Mozilla defaults.
- // When the number of cookies gets to k{Domain,}MaxCookies
- // purge down to k{Domain,}MaxCookies - k{Domain,}PurgeCookies.
- // It might seem scary to have a high purge value, but really it's not.
- // You just make sure that you increase the max to cover the increase
- // in purge, and we would have been purging the same number of cookies.
- // We're just going through the garbage collection process less often.
- // Note that the DOMAIN values are per eTLD+1; see comment for the
- // CookieMap typedef. So, e.g., the maximum number of cookies allowed for
- // google.com and all of its subdomains will be 150-180.
- //
- // Any cookies accessed more recently than kSafeFromGlobalPurgeDays will not
- // be evicted by global garbage collection, even if we have more than
- // kMaxCookies. This does not affect domain garbage collection.
- static const size_t kDomainMaxCookies;
- static const size_t kDomainPurgeCookies;
- static const size_t kMaxCookies;
- static const size_t kPurgeCookies;
- // Max number of keys to store for domains that have been purged.
- static const size_t kMaxDomainPurgedKeys;
- // Partitioned cookie garbage collection thresholds.
- static const size_t kPerPartitionDomainMaxCookies;
- // TODO(crbug.com/1225444): Add global limit to number of partitioned cookies.
- // Quota for cookies with {low, medium, high} priorities within a domain.
- static const size_t kDomainCookiesQuotaLow;
- static const size_t kDomainCookiesQuotaMedium;
- static const size_t kDomainCookiesQuotaHigh;
- // The number of days since last access that cookies will not be subject
- // to global garbage collection.
- static const int kSafeFromGlobalPurgeDays;
- // The store passed in should not have had Init() called on it yet. This
- // class will take care of initializing it. The backing store is NOT owned by
- // this class, but it must remain valid for the duration of the cookie
- // monster's existence. If |store| is NULL, then no backing store will be
- // updated. |net_log| must outlive the CookieMonster and can be null.
- CookieMonster(scoped_refptr<PersistentCookieStore> store,
- NetLog* net_log,
- bool first_party_sets_enabled);
- // Only used during unit testing.
- // |net_log| must outlive the CookieMonster.
- CookieMonster(scoped_refptr<PersistentCookieStore> store,
- base::TimeDelta last_access_threshold,
- NetLog* net_log,
- bool first_party_sets_enabled);
- CookieMonster(const CookieMonster&) = delete;
- CookieMonster& operator=(const CookieMonster&) = delete;
- ~CookieMonster() override;
- // Writes all the cookies in |list| into the store, replacing all cookies
- // currently present in store.
- // This method does not flush the backend.
- // TODO(rdsmith, mmenke): Do not use this function; it is deprecated
- // and should be removed.
- // See https://codereview.chromium.org/2882063002/#msg64.
- void SetAllCookiesAsync(const CookieList& list, SetCookiesCallback callback);
- // CookieStore implementation.
- void SetCanonicalCookieAsync(
- std::unique_ptr<CanonicalCookie> cookie,
- const GURL& source_url,
- const CookieOptions& options,
- SetCookiesCallback callback,
- absl::optional<CookieAccessResult> cookie_access_result =
- absl::nullopt) override;
- void GetCookieListWithOptionsAsync(const GURL& url,
- const CookieOptions& options,
- const CookiePartitionKeyCollection& s,
- GetCookieListCallback callback) override;
- void GetAllCookiesAsync(GetAllCookiesCallback callback) override;
- void GetAllCookiesWithAccessSemanticsAsync(
- GetAllCookiesWithAccessSemanticsCallback callback) override;
- void DeleteCanonicalCookieAsync(const CanonicalCookie& cookie,
- DeleteCallback callback) override;
- void DeleteAllCreatedInTimeRangeAsync(
- const CookieDeletionInfo::TimeRange& creation_range,
- DeleteCallback callback) override;
- void DeleteAllMatchingInfoAsync(CookieDeletionInfo delete_info,
- DeleteCallback callback) override;
- void DeleteSessionCookiesAsync(DeleteCallback callback) override;
- void DeleteMatchingCookiesAsync(DeletePredicate predicate,
- DeleteCallback callback) override;
- void FlushStore(base::OnceClosure callback) override;
- void SetForceKeepSessionState() override;
- CookieChangeDispatcher& GetChangeDispatcher() override;
- void SetCookieableSchemes(const std::vector<std::string>& schemes,
- SetCookieableSchemesCallback callback) override;
- // Enables writing session cookies into the cookie database. If this this
- // method is called, it must be called before first use of the instance
- // (i.e. as part of the instance initialization process).
- void SetPersistSessionCookies(bool persist_session_cookies);
- // The default list of schemes the cookie monster can handle.
- static const char* const kDefaultCookieableSchemes[];
- static const int kDefaultCookieableSchemesCount;
- // Find a key based on the given domain, which will be used to find all
- // cookies potentially relevant to it. This is used for lookup in cookies_ as
- // well as for PersistentCookieStore::LoadCookiesForKey. See comment on keys
- // before the CookieMap typedef.
- static std::string GetKey(base::StringPiece domain);
- // Exposes the comparison function used when sorting cookies.
- static bool CookieSorter(const CanonicalCookie* cc1,
- const CanonicalCookie* cc2);
- // Triggers immediate recording of stats that are typically reported
- // periodically.
- bool DoRecordPeriodicStatsForTesting() { return DoRecordPeriodicStats(); }
- // Will convert a site's partitioned cookies into unpartitioned cookies. This
- // may result in multiple cookies which have the same (partition_key, name,
- // host_key, path), which violates the database's unique constraint. The
- // algorithm we use to coalesce the cookies into a single unpartitioned cookie
- // is the following:
- //
- // 1. If one of the cookies has no partition key (i.e. it is unpartitioned)
- // choose this cookie.
- //
- // 2. Choose the partitioned cookie with the most recent last_access_time.
- //
- // TODO(crbug.com/1296161): Delete this when the partitioned cookies Origin
- // Trial ends.
- void ConvertPartitionedCookiesToUnpartitioned(const GURL& url) override;
- private:
- // For garbage collection constants.
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, TestHostGarbageCollection);
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest,
- GarbageCollectWithSecureCookiesOnly);
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, TestGCTimes);
- // For validation of key values.
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, TestDomainTree);
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, TestImport);
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, GetKey);
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, TestGetKey);
- // For FindCookiesForKey.
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, ShortLivedSessionCookies);
- // For CookieSource histogram enum.
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, CookieSourceHistogram);
- // For kSafeFromGlobalPurgeDays in CookieStore.
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, EvictSecureCookies);
- // For CookieDeleteEquivalent histogram enum.
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest,
- CookieDeleteEquivalentHistogramTest);
- // For CookieSentToSamePort enum.
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest,
- CookiePortReadDiffersFromSetHistogram);
- FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, IsCookieSentToSamePortThatSetIt);
- // Internal reasons for deletion, used to populate informative histograms
- // and to provide a public cause for onCookieChange notifications.
- //
- // If you add or remove causes from this list, please be sure to also update
- // the CookieChangeCause mapping inside ChangeCauseMapping. New items (if
- // necessary) should be added at the end of the list, just before
- // DELETE_COOKIE_LAST_ENTRY.
- enum DeletionCause {
- DELETE_COOKIE_EXPLICIT = 0,
- DELETE_COOKIE_OVERWRITE = 1,
- DELETE_COOKIE_EXPIRED = 2,
- DELETE_COOKIE_EVICTED = 3,
- DELETE_COOKIE_DUPLICATE_IN_BACKING_STORE = 4,
- DELETE_COOKIE_DONT_RECORD = 5, // For final cleanup after flush to store.
- // Cookies evicted during domain-level garbage collection.
- DELETE_COOKIE_EVICTED_DOMAIN = 6,
- // Cookies evicted during global garbage collection, which takes place after
- // domain-level garbage collection fails to bring the cookie store under
- // the overall quota.
- DELETE_COOKIE_EVICTED_GLOBAL = 7,
- // #8 was DELETE_COOKIE_EVICTED_DOMAIN_PRE_SAFE
- // #9 was DELETE_COOKIE_EVICTED_DOMAIN_POST_SAFE
- // A common idiom is to remove a cookie by overwriting it with an
- // already-expired expiration date. This captures that case.
- DELETE_COOKIE_EXPIRED_OVERWRITE = 10,
- // Cookies are not allowed to contain control characters in the name or
- // value. However, we used to allow them, so we are now evicting any such
- // cookies as we load them. See http://crbug.com/238041.
- DELETE_COOKIE_CONTROL_CHAR = 11,
- // When strict secure cookies is enabled, non-secure cookies are evicted
- // right after expired cookies.
- DELETE_COOKIE_NON_SECURE = 12,
- // Partitioned cookies evicted during per-partition domain-level garbage
- // collection.
- DELETE_COOKIE_EVICTED_PER_PARTITION_DOMAIN = 13,
- DELETE_COOKIE_LAST_ENTRY = 14,
- };
- // This enum is used to generate a histogramed bitmask measureing the types
- // of stored cookies. Please do not reorder the list when adding new entries.
- // New items MUST be added at the end of the list, just before
- // COOKIE_TYPE_LAST_ENTRY;
- // There will be 2^COOKIE_TYPE_LAST_ENTRY buckets in the linear histogram.
- enum CookieType {
- COOKIE_TYPE_SAME_SITE = 0,
- COOKIE_TYPE_HTTPONLY,
- COOKIE_TYPE_SECURE,
- COOKIE_TYPE_LAST_ENTRY
- };
- // Used to populate a histogram containing information about the
- // sources of Secure and non-Secure cookies: that is, whether such
- // cookies are set by origins with cryptographic or non-cryptographic
- // schemes. Please do not reorder the list when adding new
- // entries. New items MUST be added at the end of the list, and kMaxValue
- // should be updated to the last value.
- //
- // CookieSource::k(Non)SecureCookie(Non)CryptographicScheme means
- // that a cookie was set or overwritten from a URL with the given type
- // of scheme. This enum should not be used when cookies are *cleared*,
- // because its purpose is to understand if Chrome can deprecate the
- // ability of HTTP urls to set/overwrite Secure cookies.
- enum class CookieSource : uint8_t {
- kSecureCookieCryptographicScheme = 0,
- kSecureCookieNoncryptographicScheme,
- kNonsecureCookieCryptographicScheme,
- kNonsecureCookieNoncryptographicScheme,
- kMaxValue = kNonsecureCookieNoncryptographicScheme
- };
- // Enum for collecting metrics on how frequently a cookie is sent to the same
- // port it was set by.
- //
- // kNoButDefault exists because we expect for cookies being sent between
- // schemes to have a port mismatch and want to separate those out from other,
- // more interesting, cases.
- //
- // Do not reorder or renumber. Used for metrics.
- enum class CookieSentToSamePort {
- kSourcePortUnspecified = 0, // Cookie's source port is unspecified, we
- // can't know if this is the same port or not.
- kInvalid = 1, // The source port was corrupted to be PORT_INVALID, we
- // can't know if this is the same port or not.
- kNo = 2, // Source port and destination port are different.
- kNoButDefault =
- 3, // Source and destination ports are different but they're
- // the defaults for their scheme. This can mean that an http
- // cookie was sent to a https origin or vice-versa.
- kYes = 4, // They're the same.
- kMaxValue = kYes
- };
- // Record statistics every kRecordStatisticsIntervalSeconds of uptime.
- static const int kRecordStatisticsIntervalSeconds = 10 * 60;
- // Sets a canonical cookie, deletes equivalents and performs garbage
- // collection. |source_url| indicates what URL the cookie is being set
- // from; secure cookies cannot be altered from insecure schemes, and some
- // schemes may not be authorized.
- //
- // |options| indicates if this setting operation is allowed
- // to affect http_only or same-site cookies.
- //
- // |cookie_access_result| is an optional input status, to allow for status
- // chaining from callers. It helps callers provide the status of a
- // canonical cookie that may have warnings associated with it.
- void SetCanonicalCookie(
- std::unique_ptr<CanonicalCookie> cookie,
- const GURL& source_url,
- const CookieOptions& options,
- SetCookiesCallback callback,
- absl::optional<CookieAccessResult> cookie_access_result = absl::nullopt);
- void GetAllCookies(GetAllCookiesCallback callback);
- void AttachAccessSemanticsListForCookieList(
- GetAllCookiesWithAccessSemanticsCallback callback,
- const CookieList& cookie_list);
- void GetCookieListWithOptions(
- const GURL& url,
- const CookieOptions& options,
- const CookiePartitionKeyCollection& cookie_partition_key_collection,
- GetCookieListCallback callback);
- void DeleteAllCreatedInTimeRange(
- const CookieDeletionInfo::TimeRange& creation_range,
- DeleteCallback callback);
- // Returns whether |cookie| matches |delete_info|.
- bool MatchCookieDeletionInfo(const CookieDeletionInfo& delete_info,
- const net::CanonicalCookie& cookie);
- void DeleteCanonicalCookie(const CanonicalCookie& cookie,
- DeleteCallback callback);
- void DeleteMatchingCookies(DeletePredicate predicate,
- DeletionCause cause,
- DeleteCallback callback);
- // The first access to the cookie store initializes it. This method should be
- // called before any access to the cookie store.
- void MarkCookieStoreAsInitialized();
- // Fetches all cookies if the backing store exists and they're not already
- // being fetched.
- void FetchAllCookiesIfNecessary();
- // Fetches all cookies from the backing store.
- void FetchAllCookies();
- // Whether all cookies should be fetched as soon as any is requested.
- bool ShouldFetchAllCookiesWhenFetchingAnyCookie();
- // Stores cookies loaded from the backing store and invokes any deferred
- // calls. |beginning_time| should be the moment PersistentCookieStore::Load
- // was invoked and is used for reporting histogram_time_blocked_on_load_.
- // See PersistentCookieStore::Load for details on the contents of cookies.
- void OnLoaded(base::TimeTicks beginning_time,
- std::vector<std::unique_ptr<CanonicalCookie>> cookies);
- // Stores cookies loaded from the backing store and invokes the deferred
- // task(s) pending loading of cookies associated with the domain key
- // (GetKey, roughly eTLD+1). Called when all cookies for the domain key have
- // been loaded from DB. See PersistentCookieStore::Load for details on the
- // contents of cookies.
- void OnKeyLoaded(const std::string& key,
- std::vector<std::unique_ptr<CanonicalCookie>> cookies);
- // Stores the loaded cookies.
- void StoreLoadedCookies(
- std::vector<std::unique_ptr<CanonicalCookie>> cookies);
- // Invokes deferred calls.
- void InvokeQueue();
- // Checks that |cookies_| matches our invariants, and tries to repair any
- // inconsistencies. (In other words, it does not have duplicate cookies).
- void EnsureCookiesMapIsValid();
- // Checks for any duplicate cookies for CookieMap key |key| which lie between
- // |begin| and |end|. If any are found, all but the most recent are deleted.
- //
- // If |cookie_partition_it| is not nullopt, then this function trims cookies
- // from the CookieMap in |partitioned_cookies_| at |cookie_partition_it|
- // instead of trimming cookies from |cookies_|.
- void TrimDuplicateCookiesForKey(
- const std::string& key,
- CookieMap::iterator begin,
- CookieMap::iterator end,
- absl::optional<PartitionedCookieMap::iterator> cookie_partition_it);
- void SetDefaultCookieableSchemes();
- std::vector<CanonicalCookie*> FindCookiesForRegistryControlledHost(
- const GURL& url,
- CookieMap* cookie_map = nullptr);
- std::vector<CanonicalCookie*> FindPartitionedCookiesForRegistryControlledHost(
- const CookiePartitionKey& cookie_partition_key,
- const GURL& url);
- void FilterCookiesWithOptions(const GURL url,
- const CookieOptions options,
- std::vector<CanonicalCookie*>* cookie_ptrs,
- CookieAccessResultList* included_cookies,
- CookieAccessResultList* excluded_cookies);
- // Possibly delete an existing cookie equivalent to |cookie_being_set| (same
- // path, domain, and name).
- //
- // |allowed_to_set_secure_cookie| indicates if the source may override
- // existing secure cookies. If the source is not trustworthy, and there is an
- // existing "equivalent" cookie that is Secure, that cookie will be preserved,
- // under "Leave Secure Cookies Alone" (see
- // https://tools.ietf.org/html/draft-ietf-httpbis-cookie-alone-01).
- // ("equivalent" here is in quotes because the equivalency check for the
- // purposes of preserving existing Secure cookies is slightly more inclusive.)
- //
- // If |skip_httponly| is true, httponly cookies will not be deleted even if
- // they are equivalent.
- // |key| is the key to find the cookie in cookies_; see the comment before the
- // CookieMap typedef for details.
- //
- // If a cookie is deleted, and its value matches |cookie_being_set|'s value,
- // then |creation_date_to_inherit| will be set to that cookie's creation date.
- //
- // The cookie will not be deleted if |*status| is not "include" when calling
- // the function. The function will update |*status| with exclusion reasons if
- // a secure cookie was skipped or an httponly cookie was skipped.
- //
- // If |cookie_partition_it| is nullopt, it will search |cookies_| for
- // duplicates of |cookie_being_set|. Otherwise, |cookie_partition_it|'s value
- // is the iterator of the CookieMap in |partitioned_cookies_| we should search
- // for duplicates.
- //
- // NOTE: There should never be more than a single matching equivalent cookie.
- void MaybeDeleteEquivalentCookieAndUpdateStatus(
- const std::string& key,
- const CanonicalCookie& cookie_being_set,
- bool allowed_to_set_secure_cookie,
- bool skip_httponly,
- bool already_expired,
- base::Time* creation_date_to_inherit,
- CookieInclusionStatus* status,
- absl::optional<PartitionedCookieMap::iterator> cookie_partition_it);
- // Inserts `cc` into cookies_. Returns an iterator that points to the inserted
- // cookie in `cookies_`. Guarantee: all iterators to `cookies_` remain valid.
- // Dispatches the change to `change_dispatcher_` iff `dispatch_change` is
- // true.
- CookieMap::iterator InternalInsertCookie(
- const std::string& key,
- std::unique_ptr<CanonicalCookie> cc,
- bool sync_to_store,
- const CookieAccessResult& access_result,
- bool dispatch_change = true);
- // Returns true if the cookie should be (or is already) synced to the store.
- // Used for cookies during insertion and deletion into the in-memory store.
- bool ShouldUpdatePersistentStore(CanonicalCookie* cc);
- void LogCookieTypeToUMA(CanonicalCookie* cc,
- const CookieAccessResult& access_result);
- // Inserts `cc` into partitioned_cookies_. Should only be used when
- // cc->IsPartitioned() is true.
- PartitionedCookieMapIterators InternalInsertPartitionedCookie(
- std::string key,
- std::unique_ptr<CanonicalCookie> cc,
- bool sync_to_store,
- const CookieAccessResult& access_result,
- bool dispatch_change = true);
- // Sets all cookies from |list| after deleting any equivalent cookie.
- // For data gathering purposes, this routine is treated as if it is
- // restoring saved cookies; some statistics are not gathered in this case.
- void SetAllCookies(CookieList list, SetCookiesCallback callback);
- void InternalUpdateCookieAccessTime(CanonicalCookie* cc,
- const base::Time& current_time);
- // |deletion_cause| argument is used for collecting statistics and choosing
- // the correct CookieChangeCause for OnCookieChange notifications. Guarantee:
- // All iterators to cookies_, except for the deleted entry, remain valid.
- void InternalDeleteCookie(CookieMap::iterator it,
- bool sync_to_store,
- DeletionCause deletion_cause);
- // Deletes a Partitioned cookie. Returns true if the deletion operation
- // resulted in the CookieMap the cookie was stored in was deleted.
- //
- // If the CookieMap which contains the deleted cookie only has one entry, then
- // this function will also delete the CookieMap from PartitionedCookieMap.
- // This may invalidate the |cookie_partition_it| argument.
- void InternalDeletePartitionedCookie(
- PartitionedCookieMap::iterator partition_it,
- CookieMap::iterator cookie_it,
- bool sync_to_store,
- DeletionCause deletion_cause);
- // If the number of cookies for CookieMap key |key|, or globally, are
- // over the preset maximums above, garbage collect, first for the host and
- // then globally. See comments above garbage collection threshold
- // constants for details. Also removes expired cookies.
- //
- // Returns the number of cookies deleted (useful for debugging).
- size_t GarbageCollect(const base::Time& current, const std::string& key);
- // Run garbage collection for PartitionedCookieMap keys |cookie_partition_key|
- // and |key|.
- //
- // Partitioned cookies are subject to different limits than unpartitioned
- // cookies in order to prevent leaking entropy about user behavior across
- // cookie partitions.
- size_t GarbageCollectPartitionedCookies(
- const base::Time& current,
- const CookiePartitionKey& cookie_partition_key,
- const std::string& key);
- // Helper for GarbageCollect(). Deletes up to |purge_goal| cookies with a
- // priority less than or equal to |priority| from |cookies|, while ensuring
- // that at least the |to_protect| most-recent cookies are retained.
- // |protected_secure_cookies| specifies whether or not secure cookies should
- // be protected from deletion.
- //
- // |cookies| must be sorted from least-recent to most-recent.
- //
- // Returns the number of cookies deleted.
- size_t PurgeLeastRecentMatches(CookieItVector* cookies,
- CookiePriority priority,
- size_t to_protect,
- size_t purge_goal,
- bool protect_secure_cookies);
- // Helper for GarbageCollect(); can be called directly as well. Deletes all
- // expired cookies in |itpair|. If |cookie_its| is non-NULL, all the
- // non-expired cookies from |itpair| are appended to |cookie_its|.
- //
- // Returns the number of cookies deleted.
- size_t GarbageCollectExpired(const base::Time& current,
- const CookieMapItPair& itpair,
- CookieItVector* cookie_its);
- // Deletes all expired cookies in the double-keyed PartitionedCookie map in
- // the CookieMap at |cookie_partition_it|. It deletes all cookies in that
- // CookieMap in |itpair|. If |cookie_its| is non-NULL, all non-expired cookies
- // from |itpair| are appended to |cookie_its|.
- //
- // Returns the number of cookies deleted.
- size_t GarbageCollectExpiredPartitionedCookies(
- const base::Time& current,
- const PartitionedCookieMap::iterator& cookie_partition_it,
- const CookieMapItPair& itpair,
- CookieItVector* cookie_its);
- // Helper function to garbage collect all expired cookies in
- // PartitionedCookieMap.
- void GarbageCollectAllExpiredPartitionedCookies(const base::Time& current);
- // Helper for GarbageCollect(). Deletes all cookies in the range specified by
- // [|it_begin|, |it_end|). Returns the number of cookies deleted.
- size_t GarbageCollectDeleteRange(const base::Time& current,
- DeletionCause cause,
- CookieItVector::iterator cookie_its_begin,
- CookieItVector::iterator cookie_its_end);
- // Helper for GarbageCollect(). Deletes cookies in |cookie_its| from least to
- // most recently used, but only before |safe_date|. Also will stop deleting
- // when the number of remaining cookies hits |purge_goal|.
- //
- // Sets |earliest_time| to be the earliest last access time of a cookie that
- // was not deleted, or base::Time() if no such cookie exists.
- size_t GarbageCollectLeastRecentlyAccessed(const base::Time& current,
- const base::Time& safe_date,
- size_t purge_goal,
- CookieItVector cookie_its,
- base::Time* earliest_time);
- bool HasCookieableScheme(const GURL& url);
- // Get the cookie's access semantics (LEGACY or NONLEGACY), by checking for a
- // value from the cookie access delegate, if it is non-null. Otherwise returns
- // UNKNOWN.
- CookieAccessSemantics GetAccessSemanticsForCookie(
- const CanonicalCookie& cookie) const;
- // Statistics support
- // This function should be called repeatedly, and will record
- // statistics if a sufficient time period has passed.
- void RecordPeriodicStats(const base::Time& current_time);
- // Records the aforementioned stats if we have already finished loading all
- // cookies. Returns whether stats were recorded.
- bool DoRecordPeriodicStats();
- // Records periodic stats related to First-Party Sets usage. Note that since
- // First-Party Sets presents a potentially asynchronous interface, these stats
- // may be collected asynchronously w.r.t. the rest of the stats collected by
- // `RecordPeriodicStats`.
- void RecordPeriodicFirstPartySetsStats(
- base::flat_map<SchemefulSite, FirstPartySetEntry> sets) const;
- // Defers the callback until the full coookie database has been loaded. If
- // it's already been loaded, runs the callback synchronously.
- void DoCookieCallback(base::OnceClosure callback);
- // Defers the callback until the cookies relevant to given URL have been
- // loaded. If they've already been loaded, runs the callback synchronously.
- void DoCookieCallbackForURL(base::OnceClosure callback, const GURL& url);
- // Defers the callback until the cookies relevant to given host or domain
- // have been loaded. If they've already been loaded, runs the callback
- // synchronously.
- void DoCookieCallbackForHostOrDomain(base::OnceClosure callback,
- base::StringPiece host_or_domain);
- // Checks to see if a cookie is being sent to the same port it was set by. For
- // metrics.
- //
- // This is in CookieMonster because only CookieMonster uses it. It's otherwise
- // a standalone utility function.
- static CookieSentToSamePort IsCookieSentToSamePortThatSetIt(
- const GURL& destination,
- int source_port,
- CookieSourceScheme source_scheme);
- // TODO(crbug.com/1296161): Delete this when the partitioned cookies Origin
- // Trial ends.
- void OnConvertPartitionedCookiesToUnpartitioned(const GURL& url);
- void ConvertPartitionedCookie(const net::CanonicalCookie& cookie,
- const GURL& url);
- // Set of keys (eTLD+1's) for which non-expired cookies have
- // been evicted for hitting the per-domain max. The size of this set is
- // histogrammed periodically. The size is limited to |kMaxDomainPurgedKeys|.
- std::set<std::string> domain_purged_keys_;
- // The number of distinct keys (eTLD+1's) currently present in the |cookies_|
- // multimap. This is histogrammed periodically.
- size_t num_keys_ = 0u;
- CookieMap cookies_;
- PartitionedCookieMap partitioned_cookies_;
- // Number of distinct partitioned cookies globally. This is used to enforce a
- // global maximum on the number of partitioned cookies.
- size_t num_partitioned_cookies_ = 0u;
- CookieMonsterChangeDispatcher change_dispatcher_;
- // Indicates whether the cookie store has been initialized.
- bool initialized_ = false;
- // Indicates whether the cookie store has started fetching all cookies.
- bool started_fetching_all_cookies_ = false;
- // Indicates whether the cookie store has finished fetching all cookies.
- bool finished_fetching_all_cookies_ = false;
- // List of domain keys that have been loaded from the DB.
- std::set<std::string> keys_loaded_;
- // Map of domain keys to their associated task queues. These tasks are blocked
- // until all cookies for the associated domain key eTLD+1 are loaded from the
- // backend store.
- std::map<std::string, base::circular_deque<base::OnceClosure>>
- tasks_pending_for_key_;
- // Queues tasks that are blocked until all cookies are loaded from the backend
- // store.
- base::circular_deque<base::OnceClosure> tasks_pending_;
- // Once a global cookie task has been seen, all per-key tasks must be put in
- // |tasks_pending_| instead of |tasks_pending_for_key_| to ensure a reasonable
- // view of the cookie store. This is more to ensure fancy cookie export/import
- // code has a consistent view of the CookieStore, rather than out of concern
- // for typical use.
- bool seen_global_task_ = false;
- NetLogWithSource net_log_;
- scoped_refptr<PersistentCookieStore> store_;
- // Minimum delay after updating a cookie's LastAccessDate before we will
- // update it again.
- const base::TimeDelta last_access_threshold_;
- // Approximate date of access time of least recently accessed cookie
- // in |cookies_|. Note that this is not guaranteed to be accurate, only a)
- // to be before or equal to the actual time, and b) to be accurate
- // immediately after a garbage collection that scans through all the cookies
- // (When garbage collection does not scan through all cookies, it may not be
- // updated). This value is used to determine whether global garbage collection
- // might find cookies to purge. Note: The default Time() constructor will
- // create a value that compares earlier than any other time value, which is
- // wanted. Thus this value is not initialized.
- base::Time earliest_access_time_;
- std::vector<std::string> cookieable_schemes_;
- base::Time last_statistic_record_time_;
- bool persist_session_cookies_ = false;
- bool first_party_sets_enabled_;
- base::ThreadChecker thread_checker_;
- base::WeakPtrFactory<CookieMonster> weak_ptr_factory_{this};
- };
- typedef base::RefCountedThreadSafe<CookieMonster::PersistentCookieStore>
- RefcountedPersistentCookieStore;
- class NET_EXPORT CookieMonster::PersistentCookieStore
- : public RefcountedPersistentCookieStore {
- public:
- typedef base::OnceCallback<void(
- std::vector<std::unique_ptr<CanonicalCookie>>)>
- LoadedCallback;
- PersistentCookieStore(const PersistentCookieStore&) = delete;
- PersistentCookieStore& operator=(const PersistentCookieStore&) = delete;
- // Initializes the store and retrieves the existing cookies. This will be
- // called only once at startup. The callback will return all the cookies
- // that are not yet returned to CookieMonster by previous priority loads.
- //
- // |loaded_callback| may not be NULL.
- // |net_log| is a NetLogWithSource that may be copied if the persistent
- // store wishes to log NetLog events.
- virtual void Load(LoadedCallback loaded_callback,
- const NetLogWithSource& net_log) = 0;
- // Does a priority load of all cookies for the domain key (eTLD+1). The
- // callback will return all the cookies that are not yet returned by previous
- // loads, which includes cookies for the requested domain key if they are not
- // already returned, plus all cookies that are chain-loaded and not yet
- // returned to CookieMonster.
- //
- // |loaded_callback| may not be NULL.
- virtual void LoadCookiesForKey(const std::string& key,
- LoadedCallback loaded_callback) = 0;
- virtual void AddCookie(const CanonicalCookie& cc) = 0;
- virtual void UpdateCookieAccessTime(const CanonicalCookie& cc) = 0;
- virtual void DeleteCookie(const CanonicalCookie& cc) = 0;
- // Instructs the store to not discard session only cookies on shutdown.
- virtual void SetForceKeepSessionState() = 0;
- // Sets a callback that will be run before the store flushes. If |callback|
- // performs any async operations, the store will not wait for those to finish
- // before flushing.
- virtual void SetBeforeCommitCallback(base::RepeatingClosure callback) = 0;
- // Flushes the store and posts |callback| when complete. |callback| may be
- // NULL.
- virtual void Flush(base::OnceClosure callback) = 0;
- protected:
- PersistentCookieStore() = default;
- virtual ~PersistentCookieStore() = default;
- private:
- friend class base::RefCountedThreadSafe<PersistentCookieStore>;
- };
- } // namespace net
- #endif // NET_COOKIES_COOKIE_MONSTER_H_
|