1 // Copyright 2019 The Chromium Authors 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef NET_COOKIES_COOKIE_ACCESS_DELEGATE_H_ 6 #define NET_COOKIES_COOKIE_ACCESS_DELEGATE_H_ 7 8 #include "base/containers/flat_map.h" 9 #include "base/containers/flat_set.h" 10 #include "base/functional/callback_forward.h" 11 #include "net/base/net_export.h" 12 #include "net/base/schemeful_site.h" 13 #include "net/cookies/canonical_cookie.h" 14 #include "net/cookies/cookie_constants.h" 15 #include "net/cookies/cookie_partition_key.h" 16 #include "net/first_party_sets/first_party_set_entry.h" 17 #include "net/first_party_sets/first_party_set_metadata.h" 18 #include "net/first_party_sets/first_party_sets_cache_filter.h" 19 #include "third_party/abseil-cpp/absl/types/optional.h" 20 #include "url/gurl.h" 21 22 namespace net { 23 24 class SchemefulSite; 25 class SiteForCookies; 26 27 class NET_EXPORT CookieAccessDelegate { 28 public: 29 CookieAccessDelegate(); 30 31 CookieAccessDelegate(const CookieAccessDelegate&) = delete; 32 CookieAccessDelegate& operator=(const CookieAccessDelegate&) = delete; 33 34 virtual ~CookieAccessDelegate(); 35 36 // Returns true if the passed in |url| should be permitted to access secure 37 // cookies in addition to URLs that normally do so. Returning false from this 38 // method on a URL that would already be treated as secure by default, e.g. an 39 // https:// one has no effect. 40 virtual bool ShouldTreatUrlAsTrustworthy(const GURL& url) const; 41 42 // Gets the access semantics to apply to |cookie|, based on its domain (i.e., 43 // whether a policy specifies that legacy access semantics should apply). 44 virtual CookieAccessSemantics GetAccessSemantics( 45 const CanonicalCookie& cookie) const = 0; 46 47 // Returns whether a cookie should be attached regardless of its SameSite 48 // value vs the request context. 49 virtual bool ShouldIgnoreSameSiteRestrictions( 50 const GURL& url, 51 const SiteForCookies& site_for_cookies) const = 0; 52 53 // Calls `callback` with First-Party Sets metadata about `site` and 54 // `top_frame_site`, and cache filter info for `site`. Cache filter info is 55 // used to determine if the existing HTTP cache entries for `site` are allowed 56 // to be accessed. 57 // 58 // This may return a result synchronously, or asynchronously invoke `callback` 59 // with the result. The callback will be invoked iff the return value is 60 // nullopt; i.e. a result will be provided via return value or callback, but 61 // not both, and not neither. 62 [[nodiscard]] virtual absl::optional< 63 std::pair<FirstPartySetMetadata, FirstPartySetsCacheFilter::MatchInfo>> 64 ComputeFirstPartySetMetadataMaybeAsync( 65 const net::SchemefulSite& site, 66 const net::SchemefulSite* top_frame_site, 67 base::OnceCallback<void(FirstPartySetMetadata, 68 FirstPartySetsCacheFilter::MatchInfo)> callback) 69 const = 0; 70 71 // Returns the entries of a set of sites if the sites are in non-trivial sets. 72 // If a given site is not in a non-trivial set, the output does not contain a 73 // corresponding entry. 74 // 75 // This may return a result synchronously, or asynchronously invoke `callback` 76 // with the result. The callback will be invoked iff the return value is 77 // nullopt; i.e. a result will be provided via return value or callback, but 78 // not both, and not neither. 79 [[nodiscard]] virtual absl::optional< 80 base::flat_map<net::SchemefulSite, net::FirstPartySetEntry>> 81 FindFirstPartySetEntries( 82 const base::flat_set<net::SchemefulSite>& sites, 83 base::OnceCallback< 84 void(base::flat_map<net::SchemefulSite, net::FirstPartySetEntry>)> 85 callback) const = 0; 86 }; 87 88 } // namespace net 89 90 #endif // NET_COOKIES_COOKIE_ACCESS_DELEGATE_H_ 91