net/cookies/cookie_options.h - chromium/src - Git at Google

 // 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 number 42.

 #ifndef NET_COOKIES_COOKIE_OPTIONS_H_
 #define NET_COOKIES_COOKIE_OPTIONS_H_

 #include <ostream>
 #include <set>

 #include "net/base/net_export.h"
 #include "net/cookies/cookie_constants.h"
 #include "net/cookies/cookie_inclusion_status.h"
 #include "third_party/abseil-cpp/absl/types/optional.h"
 #include "url/gurl.h"

 namespace net {

 class NET_EXPORT CookieOptions {
  public:

   // Relation between the cookie and the navigational environment.
   class NET_EXPORT SameSiteCookieContext {
    public:
     // CROSS_SITE to SAME_SITE_STRICT are ordered from least to most trusted
     // environment. Don't renumber, used in histograms.
     enum class ContextType {
       CROSS_SITE = 0,
       // Same rules as lax but the http method is unsafe.
       SAME_SITE_LAX_METHOD_UNSAFE = 1,
       SAME_SITE_LAX = 2,
       SAME_SITE_STRICT = 3,

       // Keep last, used for histograms.
       COUNT
     };

     // Holds metadata about the factors that went into deciding the ContextType.
     //
     // These values may be used for recording histograms or
     // CookieInclusionStatus warnings, but SHOULD NOT be relied
     // upon for cookie inclusion decisions. Use only the ContextTypes for that.
     //
     // When adding a field, also update CompleteEquivalenceForTesting.
     struct NET_EXPORT ContextMetadata {
       // Whether the ContextType calculation was affected by the bugfix for
       // crbug.com/1166211.
       // TODO(crbug.com/1166211): Remove once no longer needed.
       bool affected_by_bugfix_1166211 = false;
     };

     // The following three constructors apply default values for the metadata
     // members.
     SameSiteCookieContext()
         : SameSiteCookieContext(ContextType::CROSS_SITE,
                                 ContextType::CROSS_SITE) {}

     explicit SameSiteCookieContext(ContextType same_site_context)
         : SameSiteCookieContext(same_site_context, same_site_context) {}

     SameSiteCookieContext(ContextType same_site_context,
                           ContextType schemeful_same_site_context)
         : SameSiteCookieContext(same_site_context,
                                 schemeful_same_site_context,
                                 ContextMetadata(),
                                 ContextMetadata()) {}

     // Schemeful and schemeless context types are consistency-checked against
     // each other, but the metadata is stored as-is (i.e. the values in
     // `metadata` and `schemeful_metadata` may be logically inconsistent), as
     // the metadata is not relied upon for correctness.
     SameSiteCookieContext(ContextType same_site_context,
                           ContextType schemeful_same_site_context,
                           ContextMetadata metadata,
                           ContextMetadata schemeful_metadata)
         : context_(same_site_context),
           schemeful_context_(schemeful_same_site_context),
           metadata_(metadata),
           schemeful_metadata_(schemeful_metadata) {
       DCHECK_LE(schemeful_context_, context_);
     }

     // Convenience method which returns a SameSiteCookieContext with the most
     // inclusive contexts. This allows access to all SameSite cookies.
     static SameSiteCookieContext MakeInclusive();

     // Convenience method which returns a SameSiteCookieContext with the most
     // inclusive contexts for set. This allows setting all SameSite cookies.
     static SameSiteCookieContext MakeInclusiveForSet();

     // Returns the context for determining SameSite cookie inclusion.
     ContextType GetContextForCookieInclusion() const;

     // Returns the metadata describing how this context was calculated, under
     // the currently applicable schemeful/schemeless mode.
     // TODO(chlily): Should take the CookieAccessSemantics as well, to
     // accurately account for the context actually used for a given cookie.
     const ContextMetadata& GetMetadataForCurrentSchemefulMode() const;

     // If you're just trying to determine if a cookie is accessible you likely
     // want to use GetContextForCookieInclusion() which will return the correct
     // context regardless the status of same-site features.
     ContextType context() const { return context_; }
     ContextType schemeful_context() const { return schemeful_context_; }

     // You probably want to use GetMetadataForCurrentSchemefulMode() instead of
     // these getters, since that takes into account the applicable schemeful
     // mode.
     const ContextMetadata& metadata() const { return metadata_; }
     const ContextMetadata& schemeful_metadata() const {
       return schemeful_metadata_;
     }

     // Sets context types. Does not check for consistency between context and
     // schemeful context. Does not touch the metadata.
     void SetContextTypesForTesting(ContextType context_type,
                                    ContextType schemeful_context_type);

     // Whether the request was affected by the bugfix, either schemefully or
     // schemelessly. This only takes the current Schemeful Same-Site Feature
     // status into account, and does not take into account the access semantics
     // used to access the cookie. (This is fine, because the call sites only
     // look at cookies which were actually excluded due to SameSite=Lax or
     // unspecified-Lax, which means that cookies with access semantics not
     // matching the Feature state will be ignored.)
     // TODO(crbug.com/1166211): Remove once no longer needed.
     bool AffectedByBugfix1166211() const;

     // If the cookie was excluded solely due to the bugfix, this applies a
     // warning to the status that will show up in the netlog. Also logs a
     // histogram showing whether the warning was applied.
     // TODO(crbug.com/1166211): Remove once no longer needed.
     void MaybeApplyBugfix1166211WarningToStatusAndLogHistogram(
         CookieInclusionStatus& status) const;

     // Returns whether the context types and all fields of the metadata structs
     // are the same.
     bool CompleteEquivalenceForTesting(
         const SameSiteCookieContext& other) const;

     // Equality operators disregard any metadata! (Only the context types are
     // compared, not how they were computed.)
     NET_EXPORT friend bool operator==(
         const CookieOptions::SameSiteCookieContext& lhs,
         const CookieOptions::SameSiteCookieContext& rhs);
     NET_EXPORT friend bool operator!=(
         const CookieOptions::SameSiteCookieContext& lhs,
         const CookieOptions::SameSiteCookieContext& rhs);

    private:
     ContextType context_;
     ContextType schemeful_context_;

     ContextMetadata metadata_;
     ContextMetadata schemeful_metadata_;
   };

   // Computed in URLRequestHttpJob for every cookie access attempt but is only
   // relevant for SameParty cookies.
   enum class SamePartyCookieContextType {
     // The opposite to kSameParty. Should be the default value.
     kCrossParty = 0,
     // If the request URL is in the same First-Party Sets as the top-frame site
     // and each member of the isolation_info.party_context.
     kSameParty = 1,
   };

   // Creates a CookieOptions object which:
   //
   // * Excludes HttpOnly cookies
   // * Excludes SameSite cookies
   // * Updates last-accessed time.
   // * Does not report excluded cookies in APIs that can do so.
   // * Excludes SameParty cookies.
   //
   // These settings can be altered by calling:
   //
   // * |set_{include,exclude}_httponly()|
   // * |set_same_site_cookie_context()|
   // * |set_do_not_update_access_time()|
   // * |set_same_party_cookie_context_type()|
   CookieOptions();
   CookieOptions(const CookieOptions& other);
   CookieOptions(CookieOptions&& other);
   ~CookieOptions();

   CookieOptions& operator=(const CookieOptions&);
   CookieOptions& operator=(CookieOptions&&);

   void set_exclude_httponly() { exclude_httponly_ = true; }
   void set_include_httponly() { exclude_httponly_ = false; }
   bool exclude_httponly() const { return exclude_httponly_; }

   // How trusted is the current browser environment when it comes to accessing
   // SameSite cookies. Default is not trusted, e.g. CROSS_SITE.
   void set_same_site_cookie_context(const SameSiteCookieContext& context) {
     same_site_cookie_context_ = context;
   }

   const SameSiteCookieContext& same_site_cookie_context() const {
     return same_site_cookie_context_;
   }

   void set_update_access_time() { update_access_time_ = true; }
   void set_do_not_update_access_time() { update_access_time_ = false; }
   bool update_access_time() const { return update_access_time_; }

   void set_return_excluded_cookies() { return_excluded_cookies_ = true; }
   void unset_return_excluded_cookies() { return_excluded_cookies_ = false; }
   bool return_excluded_cookies() const { return return_excluded_cookies_; }

   // How trusted is the current browser environment when it comes to accessing
   // SameParty cookies. Default is not trusted, e.g. kCrossParty.
   void set_same_party_cookie_context_type(
       SamePartyCookieContextType context_type) {
     same_party_cookie_context_type_ = context_type;
   }
   SamePartyCookieContextType same_party_cookie_context_type() const {
     return same_party_cookie_context_type_;
   }

   // Getter/setter of |full_party_context_size_| for logging purposes.
   void set_full_party_context_size(uint32_t len) {
     full_party_context_size_ = len;
   }
   uint32_t full_party_context_size() const { return full_party_context_size_; }

   void set_is_in_nontrivial_first_party_set(bool is_member) {
     is_in_nontrivial_first_party_set_ = is_member;
   }
   bool is_in_nontrivial_first_party_set() const {
     return is_in_nontrivial_first_party_set_;
   }

   // Convenience method for where you need a CookieOptions that will
   // work for getting/setting all types of cookies, including HttpOnly and
   // SameSite cookies. Also specifies not to update the access time, because
   // usually this is done to get all the cookies to check that they are correct,
   // including the creation time. This basically makes a CookieOptions that is
   // the opposite of the default CookieOptions.
   static CookieOptions MakeAllInclusive();

  private:
   // Keep default values in sync with
   // content/public/common/cookie_manager.mojom.
   bool exclude_httponly_ = true;
   SameSiteCookieContext same_site_cookie_context_;
   bool update_access_time_ = true;
   bool return_excluded_cookies_ = false;

   SamePartyCookieContextType same_party_cookie_context_type_ =
       SamePartyCookieContextType::kCrossParty;
   // The size of the isolation_info.party_context plus the top-frame site.
   // Stored for logging purposes.
   uint32_t full_party_context_size_ = 0;
   // Whether the site requesting cookie access (as opposed to e.g. the
   // `site_for_cookies`) is a member (or owner) of a nontrivial First-Party
   // Set.
   // This is included here temporarily, for the purpose of ignoring SameParty
   // for sites that are not participating in the Origin Trial.
   // TODO(https://crbug.com/1163990): remove this field.
   bool is_in_nontrivial_first_party_set_ = false;
 };

 // Allows gtest to print more helpful error messages instead of printing hex.
 // (No need to null-check `os` because we can assume gtest will properly pass a
 // non-null pointer, and it is dereferenced immediately anyway.)
 inline void PrintTo(CookieOptions::SameSiteCookieContext::ContextType ct,
                     std::ostream* os) {
   *os << static_cast<int>(ct);
 }

 inline void PrintTo(const CookieOptions::SameSiteCookieContext& sscc,
                     std::ostream* os) {
   *os << "{ context: ";
   PrintTo(sscc.context(), os);
   *os << ", schemeful_context: ";
   PrintTo(sscc.schemeful_context(), os);
   *os << " }";
 }

 }  // namespace net

 #endif  // NET_COOKIES_COOKIE_OPTIONS_H_
	// 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 number 42.

	#ifndef NET_COOKIES_COOKIE_OPTIONS_H_
	#define NET_COOKIES_COOKIE_OPTIONS_H_

	#include <ostream>
	#include <set>

	#include "net/base/net_export.h"
	#include "net/cookies/cookie_constants.h"
	#include "net/cookies/cookie_inclusion_status.h"
	#include "third_party/abseil-cpp/absl/types/optional.h"
	#include "url/gurl.h"

	namespace net {

	class NET_EXPORT CookieOptions {
	public:

	// Relation between the cookie and the navigational environment.
	class NET_EXPORT SameSiteCookieContext {
	public:
	// CROSS_SITE to SAME_SITE_STRICT are ordered from least to most trusted
	// environment. Don't renumber, used in histograms.
	enum class ContextType {
	CROSS_SITE = 0,
	// Same rules as lax but the http method is unsafe.
	SAME_SITE_LAX_METHOD_UNSAFE = 1,
	SAME_SITE_LAX = 2,
	SAME_SITE_STRICT = 3,

	// Keep last, used for histograms.
	COUNT
	};

	// Holds metadata about the factors that went into deciding the ContextType.
	//
	// These values may be used for recording histograms or
	// CookieInclusionStatus warnings, but SHOULD NOT be relied
	// upon for cookie inclusion decisions. Use only the ContextTypes for that.
	//
	// When adding a field, also update CompleteEquivalenceForTesting.
	struct NET_EXPORT ContextMetadata {
	// Whether the ContextType calculation was affected by the bugfix for
	// crbug.com/1166211.
	// TODO(crbug.com/1166211): Remove once no longer needed.
	bool affected_by_bugfix_1166211 = false;
	};

	// The following three constructors apply default values for the metadata
	// members.
	SameSiteCookieContext()
	: SameSiteCookieContext(ContextType::CROSS_SITE,
	ContextType::CROSS_SITE) {}

	explicit SameSiteCookieContext(ContextType same_site_context)
	: SameSiteCookieContext(same_site_context, same_site_context) {}

	SameSiteCookieContext(ContextType same_site_context,
	ContextType schemeful_same_site_context)
	: SameSiteCookieContext(same_site_context,
	schemeful_same_site_context,
	ContextMetadata(),
	ContextMetadata()) {}

	// Schemeful and schemeless context types are consistency-checked against
	// each other, but the metadata is stored as-is (i.e. the values in
	// `metadata` and `schemeful_metadata` may be logically inconsistent), as
	// the metadata is not relied upon for correctness.
	SameSiteCookieContext(ContextType same_site_context,
	ContextType schemeful_same_site_context,
	ContextMetadata metadata,
	ContextMetadata schemeful_metadata)
	: context_(same_site_context),
	schemeful_context_(schemeful_same_site_context),
	metadata_(metadata),
	schemeful_metadata_(schemeful_metadata) {
	DCHECK_LE(schemeful_context_, context_);
	}

	// Convenience method which returns a SameSiteCookieContext with the most
	// inclusive contexts. This allows access to all SameSite cookies.
	static SameSiteCookieContext MakeInclusive();

	// Convenience method which returns a SameSiteCookieContext with the most
	// inclusive contexts for set. This allows setting all SameSite cookies.
	static SameSiteCookieContext MakeInclusiveForSet();

	// Returns the context for determining SameSite cookie inclusion.
	ContextType GetContextForCookieInclusion() const;

	// Returns the metadata describing how this context was calculated, under
	// the currently applicable schemeful/schemeless mode.
	// TODO(chlily): Should take the CookieAccessSemantics as well, to
	// accurately account for the context actually used for a given cookie.
	const ContextMetadata& GetMetadataForCurrentSchemefulMode() const;

	// If you're just trying to determine if a cookie is accessible you likely
	// want to use GetContextForCookieInclusion() which will return the correct
	// context regardless the status of same-site features.
	ContextType context() const { return context_; }
	ContextType schemeful_context() const { return schemeful_context_; }

	// You probably want to use GetMetadataForCurrentSchemefulMode() instead of
	// these getters, since that takes into account the applicable schemeful
	// mode.
	const ContextMetadata& metadata() const { return metadata_; }
	const ContextMetadata& schemeful_metadata() const {
	return schemeful_metadata_;
	}

	// Sets context types. Does not check for consistency between context and
	// schemeful context. Does not touch the metadata.
	void SetContextTypesForTesting(ContextType context_type,
	ContextType schemeful_context_type);

	// Whether the request was affected by the bugfix, either schemefully or
	// schemelessly. This only takes the current Schemeful Same-Site Feature
	// status into account, and does not take into account the access semantics
	// used to access the cookie. (This is fine, because the call sites only
	// look at cookies which were actually excluded due to SameSite=Lax or
	// unspecified-Lax, which means that cookies with access semantics not
	// matching the Feature state will be ignored.)
	// TODO(crbug.com/1166211): Remove once no longer needed.
	bool AffectedByBugfix1166211() const;

	// If the cookie was excluded solely due to the bugfix, this applies a
	// warning to the status that will show up in the netlog. Also logs a
	// histogram showing whether the warning was applied.
	// TODO(crbug.com/1166211): Remove once no longer needed.
	void MaybeApplyBugfix1166211WarningToStatusAndLogHistogram(
	CookieInclusionStatus& status) const;

	// Returns whether the context types and all fields of the metadata structs
	// are the same.
	bool CompleteEquivalenceForTesting(
	const SameSiteCookieContext& other) const;

	// Equality operators disregard any metadata! (Only the context types are
	// compared, not how they were computed.)
	NET_EXPORT friend bool operator==(
	const CookieOptions::SameSiteCookieContext& lhs,
	const CookieOptions::SameSiteCookieContext& rhs);
	NET_EXPORT friend bool operator!=(
	const CookieOptions::SameSiteCookieContext& lhs,
	const CookieOptions::SameSiteCookieContext& rhs);

	private:
	ContextType context_;
	ContextType schemeful_context_;

	ContextMetadata metadata_;
	ContextMetadata schemeful_metadata_;
	};

	// Computed in URLRequestHttpJob for every cookie access attempt but is only
	// relevant for SameParty cookies.
	enum class SamePartyCookieContextType {
	// The opposite to kSameParty. Should be the default value.
	kCrossParty = 0,
	// If the request URL is in the same First-Party Sets as the top-frame site
	// and each member of the isolation_info.party_context.
	kSameParty = 1,
	};

	// Creates a CookieOptions object which:
	//
	// * Excludes HttpOnly cookies
	// * Excludes SameSite cookies
	// * Updates last-accessed time.
	// * Does not report excluded cookies in APIs that can do so.
	// * Excludes SameParty cookies.
	//
	// These settings can be altered by calling:
	//
	// * \|set_{include,exclude}_httponly()\|
	// * \|set_same_site_cookie_context()\|
	// * \|set_do_not_update_access_time()\|
	// * \|set_same_party_cookie_context_type()\|
	CookieOptions();
	CookieOptions(const CookieOptions& other);
	CookieOptions(CookieOptions&& other);
	~CookieOptions();

	CookieOptions& operator=(const CookieOptions&);
	CookieOptions& operator=(CookieOptions&&);

	void set_exclude_httponly() { exclude_httponly_ = true; }
	void set_include_httponly() { exclude_httponly_ = false; }
	bool exclude_httponly() const { return exclude_httponly_; }

	// How trusted is the current browser environment when it comes to accessing
	// SameSite cookies. Default is not trusted, e.g. CROSS_SITE.
	void set_same_site_cookie_context(const SameSiteCookieContext& context) {
	same_site_cookie_context_ = context;
	}

	const SameSiteCookieContext& same_site_cookie_context() const {
	return same_site_cookie_context_;
	}

	void set_update_access_time() { update_access_time_ = true; }
	void set_do_not_update_access_time() { update_access_time_ = false; }
	bool update_access_time() const { return update_access_time_; }

	void set_return_excluded_cookies() { return_excluded_cookies_ = true; }
	void unset_return_excluded_cookies() { return_excluded_cookies_ = false; }
	bool return_excluded_cookies() const { return return_excluded_cookies_; }

	// How trusted is the current browser environment when it comes to accessing
	// SameParty cookies. Default is not trusted, e.g. kCrossParty.
	void set_same_party_cookie_context_type(
	SamePartyCookieContextType context_type) {
	same_party_cookie_context_type_ = context_type;
	}
	SamePartyCookieContextType same_party_cookie_context_type() const {
	return same_party_cookie_context_type_;
	}

	// Getter/setter of \|full_party_context_size_\| for logging purposes.
	void set_full_party_context_size(uint32_t len) {
	full_party_context_size_ = len;
	}
	uint32_t full_party_context_size() const { return full_party_context_size_; }

	void set_is_in_nontrivial_first_party_set(bool is_member) {
	is_in_nontrivial_first_party_set_ = is_member;
	}
	bool is_in_nontrivial_first_party_set() const {
	return is_in_nontrivial_first_party_set_;
	}

	// Convenience method for where you need a CookieOptions that will
	// work for getting/setting all types of cookies, including HttpOnly and
	// SameSite cookies. Also specifies not to update the access time, because
	// usually this is done to get all the cookies to check that they are correct,
	// including the creation time. This basically makes a CookieOptions that is
	// the opposite of the default CookieOptions.
	static CookieOptions MakeAllInclusive();

	private:
	// Keep default values in sync with
	// content/public/common/cookie_manager.mojom.
	bool exclude_httponly_ = true;
	SameSiteCookieContext same_site_cookie_context_;
	bool update_access_time_ = true;
	bool return_excluded_cookies_ = false;

	SamePartyCookieContextType same_party_cookie_context_type_ =
	SamePartyCookieContextType::kCrossParty;
	// The size of the isolation_info.party_context plus the top-frame site.
	// Stored for logging purposes.
	uint32_t full_party_context_size_ = 0;
	// Whether the site requesting cookie access (as opposed to e.g. the
	// `site_for_cookies`) is a member (or owner) of a nontrivial First-Party
	// Set.
	// This is included here temporarily, for the purpose of ignoring SameParty
	// for sites that are not participating in the Origin Trial.
	// TODO(https://crbug.com/1163990): remove this field.
	bool is_in_nontrivial_first_party_set_ = false;
	};

	// Allows gtest to print more helpful error messages instead of printing hex.
	// (No need to null-check `os` because we can assume gtest will properly pass a
	// non-null pointer, and it is dereferenced immediately anyway.)
	inline void PrintTo(CookieOptions::SameSiteCookieContext::ContextType ct,
	std::ostream* os) {
	*os << static_cast<int>(ct);
	}

	inline void PrintTo(const CookieOptions::SameSiteCookieContext& sscc,
	std::ostream* os) {
	*os << "{ context: ";
	PrintTo(sscc.context(), os);
	*os << ", schemeful_context: ";
	PrintTo(sscc.schemeful_context(), os);
	*os << " }";
	}

	} // namespace net

	#endif // NET_COOKIES_COOKIE_OPTIONS_H_