RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-28 14:57:34 +00:00
Code Issues Activity Actions

Browser: Implement spec-compliant cookie storage

Browse source 
https://tools.ietf.org/html/rfc6265#section-5.3

This includes a bit of an update to how cookies are first parsed. The
storage spec requires some extra information from the parsing steps than
just the actual values that were parsed. For example, it needs to know
whether Max-Age or Expires (or both) were specified to give precedence
to Max-Age. To accommodate this, the parser now uses an intermediate
struct for storing this information. The final Cookie struct is not
created until the storage steps.

The storage itself is also updated to be keyed by a combo of the cookie
name, domain, and path.

Retrieving cookies was updated to use the spec's domain-matching
algorithm, but otherwise is not written to the spec yet. This also does
not handle evicting expired cookies yet.
This commit is contained in:
Timothy Flynn 2021-04-12 23:16:27 -04:00 • committed by Andreas Kling
parent a0111f6a3e
commit 86bdfa1edf
2 changed files with 216 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

55
Userland/Applications/Browser/CookieJar.h
View file

@ -29,7 +29,7 @@
#include <AK/HashMap.h>
#include <AK/Optional.h>
#include <AK/String.h>
#include <AK/Vector.h>
#include <AK/Traits.h>
#include <LibCore/DateTime.h>
namespace Browser {
@ -37,11 +37,25 @@ namespace Browser {
struct Cookie {
String name;
String value;
Core::DateTime creation_time {};
Core::DateTime last_access_time {};
Core::DateTime expiry_time {};
String domain {};
String path {};
bool secure { false };
bool http_only { false };
bool host_only { false };
bool persistent { false };
};
struct ParsedCookie;
struct CookieStorageKey {
bool operator==(const CookieStorageKey&) const = default;
String name;
String domain;
String path;
};
class CookieJar {
@ -53,18 +67,37 @@ public:
private:
static Optional<String> canonicalize_domain(const URL& url);
static String default_path(const URL& url);
static Optional<Cookie> parse_cookie(const String& cookie_string, String default_domain, String default_path);
static void parse_attributes(Cookie& cookie, StringView unparsed_attributes);
static void process_attribute(Cookie& cookie, StringView attribute_name, StringView attribute_value);
static void on_expires_attribute(Cookie& cookie, StringView attribute_value);
static void on_max_age_attribute(Cookie& cookie, StringView attribute_value);
static void on_domain_attribute(Cookie& cookie, StringView attribute_value);
static void on_path_attribute(Cookie& cookie, StringView attribute_value);
static void on_secure_attribute(Cookie& cookie);
static void on_http_only_attribute(Cookie& cookie);
static Optional<ParsedCookie> parse_cookie(const String& cookie_string);
static void parse_attributes(ParsedCookie& parsed_cookie, StringView unparsed_attributes);
static void process_attribute(ParsedCookie& parsed_cookie, StringView attribute_name, StringView attribute_value);
static void on_expires_attribute(ParsedCookie& parsed_cookie, StringView attribute_value);
static void on_max_age_attribute(ParsedCookie& parsed_cookie, StringView attribute_value);
static void on_domain_attribute(ParsedCookie& parsed_cookie, StringView attribute_value);
static void on_path_attribute(ParsedCookie& parsed_cookie, StringView attribute_value);
static void on_secure_attribute(ParsedCookie& parsed_cookie);
static void on_http_only_attribute(ParsedCookie& parsed_cookie);
static Optional<Core::DateTime> parse_date_time(StringView date_string);
static bool domain_matches(const String& string, const String& domain_string);
HashMap<String, Vector<Cookie>> m_cookies;
void store_cookie(ParsedCookie& parsed_cookie, const URL& url, String canonicalized_domain);
HashMap<CookieStorageKey, Cookie> m_cookies;
};
}
namespace AK {
template<>
struct Traits<Browser::CookieStorageKey> : public GenericTraits<Browser::CookieStorageKey> {
static unsigned hash(const Browser::CookieStorageKey& key)
{
unsigned hash = 0;
hash = pair_int_hash(hash, string_hash(key.name.characters(), key.name.length()));
hash = pair_int_hash(hash, string_hash(key.domain.characters(), key.domain.length()));
hash = pair_int_hash(hash, string_hash(key.path.characters(), key.path.length()));
return hash;
}
};
}