mirror of
https://github.com/pocoproject/poco.git
synced 2025-10-28 11:31:53 +01:00
added support for SameSite cookie attribute
This commit is contained in:
@@ -31,30 +31,38 @@ class NameValueCollection;
|
||||
class Net_API HTTPCookie
|
||||
/// This class represents a HTTP Cookie.
|
||||
///
|
||||
/// A cookie is a small amount of information sent by a Web
|
||||
/// server to a Web browser, saved by the browser, and later sent back
|
||||
/// to the server. A cookie's value can uniquely identify a client, so
|
||||
/// A cookie is a small amount of information sent by a Web
|
||||
/// server to a Web browser, saved by the browser, and later sent back
|
||||
/// to the server. A cookie's value can uniquely identify a client, so
|
||||
/// cookies are commonly used for session management.
|
||||
///
|
||||
/// A cookie has a name, a single value, and optional attributes such
|
||||
/// as a comment, path and domain qualifiers, a maximum age, and a
|
||||
/// A cookie has a name, a single value, and optional attributes such
|
||||
/// as a comment, path and domain qualifiers, a maximum age, and a
|
||||
/// version number.
|
||||
///
|
||||
/// This class supports both the Version 0 (by Netscape) and Version 1
|
||||
/// (by RFC 2109) cookie specifications. By default, cookies are created
|
||||
/// This class supports both the Version 0 (by Netscape) and Version 1
|
||||
/// (by RFC 2109) cookie specifications. By default, cookies are created
|
||||
/// using Version 0 to ensure the best interoperability.
|
||||
{
|
||||
public:
|
||||
enum SameSite
|
||||
{
|
||||
SAME_SITE_NOT_SPECIFIED,
|
||||
SAME_SITE_NONE,
|
||||
SAME_SITE_LAX,
|
||||
SAME_SITE_STRICT
|
||||
};
|
||||
|
||||
HTTPCookie();
|
||||
/// Creates an empty HTTPCookie.
|
||||
|
||||
|
||||
explicit HTTPCookie(const std::string& name);
|
||||
/// Creates a cookie with the given name.
|
||||
/// Creates a cookie with the given name.
|
||||
/// The cookie never expires.
|
||||
|
||||
|
||||
explicit HTTPCookie(const NameValueCollection& nvc);
|
||||
/// Creates a cookie from the given NameValueCollection.
|
||||
|
||||
|
||||
HTTPCookie(const std::string& name, const std::string& value);
|
||||
/// Creates a cookie with the given name and value.
|
||||
/// The cookie never expires.
|
||||
@@ -62,32 +70,32 @@ public:
|
||||
/// Note: If value contains whitespace or non-alphanumeric
|
||||
/// characters, the value should be escaped by calling escape()
|
||||
/// before passing it to the constructor.
|
||||
|
||||
|
||||
HTTPCookie(const HTTPCookie& cookie);
|
||||
/// Creates the HTTPCookie by copying another one.
|
||||
|
||||
~HTTPCookie();
|
||||
/// Destroys the HTTPCookie.
|
||||
|
||||
|
||||
HTTPCookie& operator = (const HTTPCookie& cookie);
|
||||
/// Assigns a cookie.
|
||||
|
||||
|
||||
void setVersion(int version);
|
||||
/// Sets the version of the cookie.
|
||||
///
|
||||
/// Version must be either 0 (denoting a Netscape cookie)
|
||||
/// or 1 (denoting a RFC 2109 cookie).
|
||||
|
||||
|
||||
int getVersion() const;
|
||||
/// Returns the version of the cookie, which is
|
||||
/// either 0 or 1.
|
||||
|
||||
/// either 0 or 1.
|
||||
|
||||
void setName(const std::string& name);
|
||||
/// Sets the name of the cookie.
|
||||
|
||||
|
||||
const std::string& getName() const;
|
||||
/// Returns the name of the cookie.
|
||||
|
||||
|
||||
void setValue(const std::string& value);
|
||||
/// Sets the value of the cookie.
|
||||
///
|
||||
@@ -97,10 +105,10 @@ public:
|
||||
/// Note: If value contains whitespace or non-alphanumeric
|
||||
/// characters, the value should be escaped by calling escape()
|
||||
/// prior to passing it to setName().
|
||||
|
||||
|
||||
const std::string& getValue() const;
|
||||
/// Returns the value of the cookie.
|
||||
|
||||
|
||||
void setComment(const std::string& comment);
|
||||
/// Sets the comment for the cookie.
|
||||
///
|
||||
@@ -111,7 +119,7 @@ public:
|
||||
|
||||
void setDomain(const std::string& domain);
|
||||
/// Sets the domain for the cookie.
|
||||
|
||||
|
||||
const std::string& getDomain() const;
|
||||
/// Returns the domain for the cookie.
|
||||
|
||||
@@ -120,7 +128,7 @@ public:
|
||||
|
||||
void setPriority(const std::string& priority);
|
||||
/// Sets the priority for the cookie.
|
||||
|
||||
|
||||
const std::string& getPath() const;
|
||||
/// Returns the path for the cookie.
|
||||
|
||||
@@ -130,7 +138,7 @@ public:
|
||||
void setSecure(bool secure);
|
||||
/// Sets the value of the secure flag for
|
||||
/// the cookie.
|
||||
|
||||
|
||||
bool getSecure() const;
|
||||
/// Returns the value of the secure flag
|
||||
/// for the cookie.
|
||||
@@ -139,7 +147,7 @@ public:
|
||||
/// Sets the maximum age in seconds for
|
||||
/// the cookie.
|
||||
///
|
||||
/// A value of -1 (default) causes the cookie
|
||||
/// A value of -1 (default) causes the cookie
|
||||
/// to become a session cookie, which will
|
||||
/// be deleted when the browser window
|
||||
/// is closed.
|
||||
@@ -150,19 +158,25 @@ public:
|
||||
int getMaxAge() const;
|
||||
/// Returns the maximum age in seconds for
|
||||
/// the cookie.
|
||||
|
||||
|
||||
void setHttpOnly(bool flag = true);
|
||||
/// Sets the HttpOnly flag for the cookie.
|
||||
|
||||
|
||||
bool getHttpOnly() const;
|
||||
/// Returns true iff the cookie's HttpOnly flag is set.
|
||||
|
||||
|
||||
void setSameSite(SameSite value);
|
||||
/// Sets the cookie's SameSite attribute.
|
||||
|
||||
SameSite getSameSite() const;
|
||||
/// Returns the cookie's SameSite attribute.
|
||||
|
||||
std::string toString() const;
|
||||
/// Returns a string representation of the cookie,
|
||||
/// suitable for use in a Set-Cookie header.
|
||||
|
||||
|
||||
static std::string escape(const std::string& str);
|
||||
/// Escapes the given string by replacing all
|
||||
/// Escapes the given string by replacing all
|
||||
/// non-alphanumeric characters with escape
|
||||
/// sequences in the form %xx, where xx is the
|
||||
/// hexadecimal character code.
|
||||
@@ -183,7 +197,7 @@ public:
|
||||
/// - grave accent `
|
||||
/// - comma and semicolon , and ;
|
||||
/// - whitespace and control characters
|
||||
|
||||
|
||||
static std::string unescape(const std::string& str);
|
||||
/// Unescapes the given string by replacing all
|
||||
/// escape sequences in the form %xx with the
|
||||
@@ -200,6 +214,7 @@ private:
|
||||
bool _secure;
|
||||
int _maxAge;
|
||||
bool _httpOnly;
|
||||
SameSite _sameSite;
|
||||
};
|
||||
|
||||
|
||||
@@ -266,6 +281,12 @@ inline bool HTTPCookie::getHttpOnly() const
|
||||
}
|
||||
|
||||
|
||||
inline HTTPCookie::SameSite HTTPCookie::getSameSite() const
|
||||
{
|
||||
return _sameSite;
|
||||
}
|
||||
|
||||
|
||||
} } // namespace Poco::Net
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user