Cookies: HTTP State Management Mechanism

2.1. Conformance Criteria

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].¶

Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and abort these steps") are to be interpreted with the meaning of the key word ("MUST", "SHOULD", "MAY", etc.) used in introducing the algorithm.¶

Conformance requirements phrased as algorithms or specific steps can be implemented in any manner, so long as the end result is equivalent. In particular, the algorithms defined in this specification are intended to be easy to understand and are not intended to be performant.¶

2.2. Syntax Notation

This specification uses the Augmented Backus-Naur Form (ABNF) notation of [RFC5234].¶

The following core rules are included by reference, as defined in [RFC5234], Appendix B.1: ALPHA (letters), CR (carriage return), CRLF (CR LF), CTLs (controls), DIGIT (decimal 0-9), DQUOTE (double quote), HEXDIG (hexadecimal 0-9/A-F/a-f), LF (line feed), NUL (null octet), OCTET (any 8-bit sequence of data except NUL), SP (space), HTAB (horizontal tab), CHAR (any [USASCII] character), VCHAR (any visible [USASCII] character), and WSP (whitespace).¶

The OWS (optional whitespace) and BWS (bad whitespace) rules are defined in Section 5.6.3 of [HTTPSEM].¶

2.3. Terminology

The terms "user agent", "client", "server", "proxy", and "origin server" have the same meaning as in the HTTP/1.1 specification ([HTTPSEM], Section 3).¶

The request-host is the name of the host, as known by the user agent, to which the user agent is sending an HTTP request or from which it is receiving an HTTP response (i.e., the name of the host to which it sent the corresponding HTTP request).¶

The term request-uri refers to "target URI" as defined in Section 7.1 of [HTTPSEM].¶

Two sequences of octets are said to case-insensitively match each other if and only if they are equivalent under the i;ascii-casemap collation defined in [RFC4790].¶

The term string means a sequence of non-NUL octets.¶

The terms "active browsing context", "active document", "ancestor navigables", "container document", "content navigable", "dedicated worker", "Document", "inclusive ancestor navigables", "navigable", "opaque origin", "sandboxed origin browsing context flag", "shared worker", "the worker's Documents", "top-level traversable", and "WorkerGlobalScope" are defined in [HTML].¶

"Service Workers" are defined in the Service Workers specification [SERVICE-WORKERS].¶

The term "origin", the mechanism of deriving an origin from a URI, and the "the same" matching algorithm for origins are defined in [RFC6454].¶

"Safe" HTTP methods include GET, HEAD, OPTIONS, and TRACE, as defined in Section 9.2.1 of [HTTPSEM].¶

A domain's "public suffix" is the portion of a domain that is controlled by a public registry, such as "com", "co.uk", and "pvt.k12.wy.us". A domain's "registrable domain" is the domain's public suffix plus the label to its left. That is, for https://www.site.example, the public suffix is example, and the registrable domain is site.example. Whenever possible, user agents SHOULD use an up-to-date public suffix list, such as the one maintained by the Mozilla project at [PSL].¶

The term "request", as well as a request's "client", "current url", "method", "target browsing context", and "url list", are defined in [FETCH].¶

The term "non-HTTP APIs" refers to non-HTTP mechanisms used to set and retrieve cookies, such as a web browser API that exposes cookies to scripts.¶

The term "top-level navigation" refers to a navigation of a top-level traversable.¶

3.1. Examples

Using the Set-Cookie header field, a server can send the user agent a short string in an HTTP response that the user agent will return in future HTTP requests that are within the scope of the cookie. For example, the server can send the user agent a "session identifier" named SID with the value 31d4d96e407aad42. The user agent then returns the session identifier in subsequent requests.¶

== Server -> User Agent ==

Set-Cookie: SID=31d4d96e407aad42

== User Agent -> Server ==

Cookie: SID=31d4d96e407aad42

The server can alter the default scope of the cookie using the Path and Domain attributes. For example, the server can instruct the user agent to return the cookie to every path and every subdomain of site.example.¶

== Server -> User Agent ==

Set-Cookie: SID=31d4d96e407aad42; Path=/; Domain=site.example

== User Agent -> Server ==

Cookie: SID=31d4d96e407aad42

As shown in the next example, the server can store multiple cookies at the user agent. For example, the server can store a session identifier as well as the user's preferred language by returning two Set-Cookie header fields. Notice that the server uses the Secure and HttpOnly attributes to provide additional security protections for the more sensitive session identifier (see Section 4.1.2).¶

== Server -> User Agent ==

Set-Cookie: SID=31d4d96e407aad42; Path=/; Secure; HttpOnly
Set-Cookie: lang=en-US; Path=/; Domain=site.example

== User Agent -> Server ==

Cookie: SID=31d4d96e407aad42; lang=en-US

Notice that the Cookie header field above contains two cookies, one named SID and one named lang. If the server wishes the user agent to persist the cookie over multiple "sessions" (e.g., user agent restarts), the server can specify an expiration date in the Expires attribute. Note that the user agent might delete the cookie before the expiration date if the user agent's cookie store exceeds its quota or if the user manually deletes the server's cookie.¶

== Server -> User Agent ==

Set-Cookie: lang=en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT

== User Agent -> Server ==

Cookie: SID=31d4d96e407aad42; lang=en-US

Finally, to remove a cookie, the server returns a Set-Cookie header field with an expiration date in the past. The server will be successful in removing the cookie only if the Path and the Domain attribute in the Set-Cookie header field match the values used when the cookie was created.¶

== Server -> User Agent ==

Set-Cookie: lang=; Expires=Sun, 06 Nov 1994 08:49:37 GMT

== User Agent -> Server ==

Cookie: SID=31d4d96e407aad42

3.2. Which Requirements to Implement

The upcoming two sections, Section 4 and Section 5, discuss the set of requirements for two distinct types of implementations. This section is meant to help guide implementers in determining which set of requirements best fits their goals. Choosing the wrong set of requirements could result in a lack of compatibility with other cookie implementations.¶

It's important to note that being compatible means different things depending on the implementer's goals. These differences have built up over time due to both intentional and unintentional spec changes, spec interpretations, and historical implementation differences.¶

This section roughly divides implementers of the cookie spec into two types, producers and consumers. These are not official terms and are only used here to help readers develop an intuitive understanding of the use cases.¶

4.1. Set-Cookie

The Set-Cookie HTTP response header field is used to send cookies from the server to the user agent.¶

set-cookie        = set-cookie-string
set-cookie-string = BWS cookie-pair *( BWS ";" OWS cookie-av )
cookie-pair       = cookie-name BWS "=" BWS cookie-value
cookie-name       = 1*cookie-octet
cookie-value      = *cookie-octet / ( DQUOTE *cookie-octet DQUOTE )
cookie-octet      = %x21 / %x23-2B / %x2D-3A / %x3C-5B / %x5D-7E
                      ; US-ASCII characters excluding CTLs,
                      ; whitespace DQUOTE, comma, semicolon,
                      ; and backslash

cookie-av         = expires-av / max-age-av / domain-av /
                    path-av / secure-av / httponly-av /
                    samesite-av / extension-av
expires-av        = "Expires" BWS "=" BWS sane-cookie-date
sane-cookie-date  =
    <IMF-fixdate, defined in [HTTPSEM], Section 5.6.7>
max-age-av        = "Max-Age" BWS "=" BWS non-zero-digit *DIGIT
non-zero-digit    = %x31-39
                      ; digits 1 through 9
domain-av         = "Domain" BWS "=" BWS domain-value
domain-value      = <subdomain>
                      ; see details below
path-av           = "Path" BWS "=" BWS path-value
path-value        = *av-octet
secure-av         = "Secure"
httponly-av       = "HttpOnly"
samesite-av       = "SameSite" BWS "=" BWS samesite-value
samesite-value    = "Strict" / "Lax" / "None"
extension-av      = *av-octet
av-octet          = %x20-3A / %x3C-7E
                      ; any CHAR except CTLs or ";"

Set-Cookie: __Secure-SID=12345; Domain=site.example

Set-Cookie: __Secure-SID=12345; Domain=site.example; Secure

Set-Cookie: __Host-SID=12345
Set-Cookie: __Host-SID=12345; Secure
Set-Cookie: __Host-SID=12345; Domain=site.example
Set-Cookie: __Host-SID=12345; Domain=site.example; Path=/
Set-Cookie: __Host-SID=12345; Secure; Domain=site.example; Path=/

Set-Cookie: __Host-SID=12345; Secure; Path=/

4.2. Cookie

cookie        = cookie-string
cookie-string = cookie-pair *( ";" SP cookie-pair )

5.1. Subcomponent Algorithms

This section defines some algorithms used by user agents to process specific subcomponents of the Cookie and Set-Cookie header fields.¶

5.2. "Same-site" and "cross-site" Requests

Two origins are same-site if they satisfy the "same site" criteria defined in [SAMESITE]. A request is "same-site" if the following criteria are true:¶

1. The request is not the result of a cross-site redirect. That is, the origin of every url in the request's url list is same-site with the request's current url's origin.¶
2. The request is not the result of a reload navigation triggered through a user interface element (as defined by the user agent; e.g., a request triggered by the user clicking a refresh button on a toolbar).¶
3. The request's current url's origin is same-site with the request's client's "site for cookies" (which is an origin), or if the request has no client or the request's client is null.¶

Requests which are the result of a reload navigation triggered through a user interface element are same-site if the reloaded document was originally navigated to via a same-site request. A request that is not "same-site" is instead "cross-site".¶

The request's client's "site for cookies" is calculated depending upon its client's type, as described in the following subsections:¶

5.3. Ignoring Set-Cookie Header Fields

User agents MAY ignore Set-Cookie header fields contained in responses with 100-level status codes or based on its cookie policy (see Section 7.2).¶

All other Set-Cookie header fields SHOULD be processed according to Section 5.5. That is, Set-Cookie header fields contained in responses with non-100-level status codes (including those in responses with 400- and 500-level status codes) SHOULD be processed unless ignored according to the user agent's cookie policy.¶

5.4. Cookie Name Prefixes

User agents' requirements for cookie name prefixes differ slightly from servers' (Section 4.1.3) in that UAs MUST match the prefix string case-insensitively.¶

The normative requirements for the prefixes are detailed in the storage model algorithm defined in Section 5.6.¶

This is because some servers will process cookie case-insensitively, resulting in them unintentionally miscapitalizing and accepting miscapitalized prefixes.¶

For example, if a server sends the following Set-Cookie header field¶

Set-Cookie: __SECURE-SID=12345

to a UA which checks prefixes case-sensitively it will accept this cookie and the server would incorrectly believe the cookie is subject the same guarantees as one spelled __Secure-.¶

Additionally the server is vulnerable to an attacker that purposefully miscapitalizes a cookie in order to impersonate a prefixed cookie. For example, a site already has a cookie __Secure-SID=12345 and by some means an attacker sends the following Set-Cookie header field for the site to a UA which checks prefixes case-sensitively.¶

Set-Cookie: __SeCuRe-SID=evil

The next time a user visits the site the UA will send both cookies:¶

Cookie: __Secure-SID=12345; __SeCuRe-SID=evil

The server, being case-insensitive, won't be able to tell the difference between the two cookies allowing the attacker to compromise the site.¶

To prevent these issues, UAs MUST match cookie name prefixes case-insensitive.¶

Note: Cookies with different names are still considered separate by UAs. So both __Secure-foo=bar and __secure-foo=baz can exist as distinct cookies simultaneously and both would have the requirements of the __Secure- prefix applied.¶

The following are examples of Set-Cookie header fields that would be rejected by a conformant user agent.¶

Set-Cookie: __Secure-SID=12345; Domain=site.example
Set-Cookie: __secure-SID=12345; Domain=site.example
Set-Cookie: __SECURE-SID=12345; Domain=site.example
Set-Cookie: __Host-SID=12345
Set-Cookie: __host-SID=12345; Secure
Set-Cookie: __host-SID=12345; Domain=site.example
Set-Cookie: __HOST-SID=12345; Domain=site.example; Path=/
Set-Cookie: __Host-SID=12345; Secure; Domain=site.example; Path=/
Set-Cookie: __host-SID=12345; Secure; Domain=site.example; Path=/
Set-Cookie: __HOST-SID=12345; Secure; Domain=site.example; Path=/

Whereas the following Set-Cookie header fields would be accepted if set from a secure origin.¶

Set-Cookie: __Secure-SID=12345; Domain=site.example; Secure
Set-Cookie: __secure-SID=12345; Domain=site.example; Secure
Set-Cookie: __SECURE-SID=12345; Domain=site.example; Secure
Set-Cookie: __Host-SID=12345; Secure; Path=/
Set-Cookie: __host-SID=12345; Secure; Path=/
Set-Cookie: __HOST-SID=12345; Secure; Path=/

5.5. The Set-Cookie Header Field

When a user agent receives a Set-Cookie header field in an HTTP response, the user agent MAY ignore the Set-Cookie header field in its entirety (see Section 5.3).¶

If the user agent does not ignore the Set-Cookie header field in its entirety, the user agent MUST parse the field-value of the Set-Cookie header field as a set-cookie-string (defined below).¶

NOTE: The algorithm below is more permissive than the grammar in Section 4.1. For example, the algorithm strips leading and trailing whitespace from the cookie name and value (but maintains internal whitespace), whereas the grammar in Section 4.1 forbids whitespace in these positions. In addition, the algorithm below accommodates some characters that are not cookie-octets according to the grammar in Section 4.1. User agents use this algorithm so as to interoperate with servers that do not follow the recommendations in Section 4.¶

NOTE: As set-cookie-string may originate from a non-HTTP API, it is not guaranteed to be free of CTL characters, so this algorithm handles them explicitly. Horizontal tab (%x09) is excluded from the CTL characters that lead to set-cookie-string rejection, as it is considered whitespace, which is handled separately.¶

NOTE: The set-cookie-string may contain octet sequences that appear percent-encoded as per Section 2.1 of [RFC3986]. However, a user agent MUST NOT decode these sequences and instead parse the individual octets as specified in this algorithm.¶

A user agent MUST use an algorithm equivalent to the following algorithm to parse a set-cookie-string:¶

1. If the set-cookie-string contains a %x00-08 / %x0A-1F / %x7F character (CTL characters excluding HTAB): Abort these steps and ignore the set-cookie-string entirely.¶

2. If the set-cookie-string contains a %x3B (";") character:¶

   1. The name-value-pair string consists of the characters up to, but not including, the first %x3B (";"), and the unparsed-attributes consist of the remainder of the set-cookie-string (including the %x3B (";") in question).¶

   Otherwise:¶

   1. The name-value-pair string consists of all the characters contained in the set-cookie-string, and the unparsed-attributes is the empty string.¶

3. If the name-value-pair string lacks a %x3D ("=") character, then the name string is empty, and the value string is the value of name-value-pair.¶

   Otherwise, the name string consists of the characters up to, but not including, the first %x3D ("=") character, and the (possibly empty) value string consists of the characters after the first %x3D ("=") character.¶

4. Remove any leading or trailing WSP characters from the name string and the value string.¶
5. If the sum of the lengths of the name string and the value string is more than 4096 octets, abort these steps and ignore the set-cookie-string entirely.¶
6. The cookie-name is the name string, and the cookie-value is the value string.¶

The user agent MUST use an algorithm equivalent to the following algorithm to parse the unparsed-attributes:¶

1. If the unparsed-attributes string is empty, skip the rest of these steps.¶
2. Discard the first character of the unparsed-attributes (which will be a %x3B (";") character).¶

3. If the remaining unparsed-attributes contains a %x3B (";") character:¶

   1. Consume the characters of the unparsed-attributes up to, but not including, the first %x3B (";") character.¶

   Otherwise:¶

   1. Consume the remainder of the unparsed-attributes.¶

   Let the cookie-av string be the characters consumed in this step.¶

4. If the cookie-av string contains a %x3D ("=") character:¶

   1. The (possibly empty) attribute-name string consists of the characters up to, but not including, the first %x3D ("=") character, and the (possibly empty) attribute-value string consists of the characters after the first %x3D ("=") character.¶

   Otherwise:¶

   1. The attribute-name string consists of the entire cookie-av string, and the attribute-value string is empty.¶
5. Remove any leading or trailing WSP characters from the attribute-name string and the attribute-value string.¶
6. If the attribute-value is longer than 1024 octets, ignore the cookie-av string and return to Step 1 of this algorithm.¶
7. Process the attribute-name and attribute-value according to the requirements in the following subsections. (Notice that attributes with unrecognized attribute-names are ignored.)¶
8. Return to Step 1 of this algorithm.¶

When the user agent finishes parsing the set-cookie-string, the user agent is said to "receive a cookie" from the request-uri with name cookie-name, value cookie-value, and attributes cookie-attribute-list. (See Section 5.6 for additional requirements triggered by receiving a cookie.)¶

 * The HTTP request associated with the retrieval uses a "safe"
   method.

 * At least one of the following is true:

   1.  The HTTP request associated with the retrieval uses a "safe"
       method.

   2.  The cookie's same-site-flag is "Default" and the amount of
       time elapsed since the cookie's creation-time is at most a
       duration of the user agent's choosing.

5.6. Storage Model

The user agent stores the following fields about each cookie: name, value, expiry-time, domain, path, creation-time, last-access-time, persistent-flag, host-only-flag, secure-only-flag, http-only-flag, and same-site-flag.¶

When the user agent "receives a cookie" from a request-uri with name cookie-name, value cookie-value, and attributes cookie-attribute-list, the user agent MUST process the cookie as follows:¶

1. A user agent MAY ignore a received cookie in its entirety. See Section 5.3.¶
2. If cookie-name is empty and cookie-value is empty, abort these steps and ignore the cookie entirely.¶
3. If the cookie-name or the cookie-value contains a %x00-08 / %x0A-1F / %x7F character (CTL characters excluding HTAB), abort these steps and ignore the cookie entirely.¶
4. If the sum of the lengths of cookie-name and cookie-value is more than 4096 octets, abort these steps and ignore the cookie entirely.¶
5. Create a new cookie with name cookie-name, value cookie-value. Set the creation-time and the last-access-time to the current date and time.¶

6. If the cookie-attribute-list contains an attribute with an attribute-name of "Max-Age":¶

   1. Set the cookie's persistent-flag to true.¶
   2. Set the cookie's expiry-time to attribute-value of the last attribute in the cookie-attribute-list with an attribute-name of "Max-Age".¶

   Otherwise, if the cookie-attribute-list contains an attribute with an attribute-name of "Expires" (and does not contain an attribute with an attribute-name of "Max-Age"):¶

   1. Set the cookie's persistent-flag to true.¶
   2. Set the cookie's expiry-time to attribute-value of the last attribute in the cookie-attribute-list with an attribute-name of "Expires".¶

   Otherwise:¶

   1. Set the cookie's persistent-flag to false.¶
   2. Set the cookie's expiry-time to the latest representable date.¶

7. If the cookie-attribute-list contains an attribute with an attribute-name of "Domain":¶

   1. Let the domain-attribute be the attribute-value of the last attribute in the cookie-attribute-list with both an attribute-name of "Domain" and an attribute-value whose length is no more than 1024 octets. (Note that a leading %x2E ("."), if present, is ignored even though that character is not permitted.)¶

   Otherwise:¶

   1. Let the domain-attribute be the empty string.¶
8. If the domain-attribute contains a character that is not in the range of [USASCII] characters, abort these steps and ignore the cookie entirely.¶

9. If the user agent is configured to reject "public suffixes" and the domain-attribute is a public suffix:¶

   1. If the domain-attribute is identical to the canonicalized request-host:¶

      1. Let the domain-attribute be the empty string.¶

      Otherwise:¶

      1. Abort these steps and ignore the cookie entirely.¶

   NOTE: This step prevents attacker.example from disrupting the integrity of site.example by setting a cookie with a Domain attribute of "example".¶

10. If the domain-attribute is non-empty:¶

    1. If the canonicalized request-host does not domain-match the domain-attribute:¶

       1. Abort these steps and ignore the cookie entirely.¶

       Otherwise:¶

       1. Set the cookie's host-only-flag to false.¶
       2. Set the cookie's domain to the domain-attribute.¶

    Otherwise:¶

    1. Set the cookie's host-only-flag to true.¶
    2. Set the cookie's domain to the canonicalized request-host.¶
11. If the cookie-attribute-list contains an attribute with an attribute-name of "Path", set the cookie's path to attribute-value of the last attribute in the cookie-attribute-list with both an attribute-name of "Path" and an attribute-value whose length is no more than 1024 octets. Otherwise, set the cookie's path to the default-path of the request-uri.¶
12. If the cookie-attribute-list contains an attribute with an attribute-name of "Secure", set the cookie's secure-only-flag to true. Otherwise, set the cookie's secure-only-flag to false.¶
13. If the scheme component of the request-uri does not denote a "secure" protocol (as defined by the user agent), and the cookie's secure-only-flag is true, then abort these steps and ignore the cookie entirely.¶
14. If the cookie-attribute-list contains an attribute with an attribute-name of "HttpOnly", set the cookie's http-only-flag to true. Otherwise, set the cookie's http-only-flag to false.¶
15. If the cookie was received from a "non-HTTP" API and the cookie's http-only-flag is true, abort these steps and ignore the cookie entirely.¶

16. If the cookie's secure-only-flag is false, and the scheme component of request-uri does not denote a "secure" protocol, then abort these steps and ignore the cookie entirely if the cookie store contains one or more cookies that meet all of the following criteria:¶

    1. Their name matches the name of the newly-created cookie.¶
    2. Their secure-only-flag is true.¶
    3. Their domain domain-matches the domain of the newly-created cookie, or vice-versa.¶
    4. The path of the newly-created cookie path-matches the path of the existing cookie.¶

    Note: The path comparison is not symmetric, ensuring only that a newly-created, non-secure cookie does not overlay an existing secure cookie, providing some mitigation against cookie-fixing attacks. That is, given an existing secure cookie named 'a' with a path of '/login', a non-secure cookie named 'a' could be set for a path of '/' or '/foo', but not for a path of '/login' or '/login/en'.¶

17. If the cookie-attribute-list contains an attribute with an attribute-name of "SameSite", and an attribute-value of "Strict", "Lax", or "None", set the cookie's same-site-flag to the attribute-value of the last attribute in the cookie-attribute-list with an attribute-name of "SameSite". Otherwise, set the cookie's same-site-flag to "Default".¶

18. If the cookie's same-site-flag is not "None":¶

    1. If the cookie was received from a "non-HTTP" API, and the API was called from a navigable's active document whose "site for cookies" is not same-site with the top-level origin, then abort these steps and ignore the newly created cookie entirely.¶
    2. If the cookie was received from a "same-site" request (as defined in Section 5.2), skip the remaining substeps and continue processing the cookie.¶

    3. If the cookie was received from a request which is navigating a top-level traversable [HTML] (e.g. if the request's "reserved client" is either null or an environment whose "target browsing context"'s navigable is a top-level traversable), skip the remaining substeps and continue processing the cookie.¶

       Note: Top-level navigations can create a cookie with any SameSite value, even if the new cookie wouldn't have been sent along with the request had it already existed prior to the navigation.¶

    4. Abort these steps and ignore the newly created cookie entirely.¶
19. If the cookie's "same-site-flag" is "None", abort these steps and ignore the cookie entirely unless the cookie's secure-only-flag is true.¶
20. If the cookie-name begins with a case-insensitive match for the string "__Secure-", abort these steps and ignore the cookie entirely unless the cookie's secure-only-flag is true.¶

21. If the cookie-name begins with a case-insensitive match for the string "__Host-", abort these steps and ignore the cookie entirely unless the cookie meets all the following criteria:¶

    1. The cookie's secure-only-flag is true.¶
    2. The cookie's host-only-flag is true.¶
    3. The cookie-attribute-list contains an attribute with an attribute-name of "Path", and the cookie's path is /.¶

22. If the cookie-name is empty and either of the following conditions are true, abort these steps and ignore the cookie:¶

    • the cookie-value begins with a case-insensitive match for the string "__Secure-"¶
    • the cookie-value begins with a case-insensitive match for the string "__Host-"¶

23. If the cookie store contains a cookie with the same name, domain, host-only-flag, and path as the newly-created cookie:¶

    1. Let old-cookie be the existing cookie with the same name, domain, host-only-flag, and path as the newly-created cookie. (Notice that this algorithm maintains the invariant that there is at most one such cookie.)¶
    2. If the newly-created cookie was received from a "non-HTTP" API and the old-cookie's http-only-flag is true, abort these steps and ignore the newly created cookie entirely.¶
    3. Update the creation-time of the newly-created cookie to match the creation-time of the old-cookie.¶
    4. Remove the old-cookie from the cookie store.¶
24. Insert the newly-created cookie into the cookie store.¶

A cookie is "expired" if the cookie has an expiry date in the past.¶

The user agent MUST evict all expired cookies from the cookie store if, at any time, an expired cookie exists in the cookie store.¶

At any time, the user agent MAY "remove excess cookies" from the cookie store if the number of cookies sharing a domain field exceeds some implementation-defined upper bound (such as 50 cookies).¶

At any time, the user agent MAY "remove excess cookies" from the cookie store if the cookie store exceeds some predetermined upper bound (such as 3000 cookies).¶

When the user agent removes excess cookies from the cookie store, the user agent MUST evict cookies in the following priority order:¶

1. Expired cookies.¶
2. Cookies whose secure-only-flag is false, and which share a domain field with more than a predetermined number of other cookies.¶
3. Cookies that share a domain field with more than a predetermined number of other cookies.¶
4. All cookies.¶

If two cookies have the same removal priority, the user agent MUST evict the cookie with the earliest last-access-time first.¶

When "the current session is over" (as defined by the user agent), the user agent MUST remove from the cookie store all cookies with the persistent-flag set to false.¶

5.7. Retrieval Model

This section defines how cookies are retrieved from a cookie store in the form of a cookie-string. A "retrieval" is any event which requires generating a cookie-string. For example, a retrieval may occur in order to build a Cookie header field for an HTTP request, or may be required in order to return a cookie-string from a call to a "non-HTTP" API that provides access to cookies. A retrieval has an associated URI, same-site status, and type, which are defined below depending on the type of retrieval.¶

6.1. Limits

Practical user agent implementations have limits on the number and size of cookies that they can store. General-use user agents SHOULD provide each of the following minimum capabilities:¶

• At least 50 cookies per domain.¶
• At least 3000 cookies total.¶

User agents MAY limit the maximum number of cookies they store, and may evict any cookie at any time (whether at the request of the user or due to implementation limitations).¶

Note that a limit on the maximum number of cookies also limits the total size of the stored cookies, due to the length limits which MUST be enforced in Section 5.5.¶

Servers SHOULD use as few and as small cookies as possible to avoid reaching these implementation limits and to minimize network bandwidth due to the Cookie header field being included in every request.¶

Servers SHOULD gracefully degrade if the user agent fails to return one or more cookies in the Cookie header field because the user agent might evict any cookie at any time.¶

6.2. Application Programming Interfaces

One reason the Cookie and Set-Cookie header fields use such esoteric syntax is that many platforms (both in servers and user agents) provide a string-based application programming interface (API) to cookies, requiring application-layer programmers to generate and parse the syntax used by the Cookie and Set-Cookie header fields, which many programmers have done incorrectly, resulting in interoperability problems.¶

Instead of providing string-based APIs to cookies, platforms would be well-served by providing more semantic APIs. It is beyond the scope of this document to recommend specific API designs, but there are clear benefits to accepting an abstract "Date" object instead of a serialized date string.¶

6.3. IDNA Dependency and Migration

IDNA2008 [RFC5890] supersedes IDNA2003 [RFC3490]. However, there are differences between the two specifications, and thus there can be differences in processing (e.g., converting) domain name labels that have been registered under one from those registered under the other. There will be a transition period of some time during which IDNA2003-based domain name labels will exist in the wild. User agents SHOULD implement IDNA2008 [RFC5890] and MAY implement [UTS46] or [RFC5895] in order to facilitate their IDNA transition. If a user agent does not implement IDNA2008, the user agent MUST implement IDNA2003 [RFC3490].¶

7.1. Third-Party Cookies

A "third-party" or cross-site cookie is one that is associated with embedded content (such as scripts, images, stylesheets, frames) that is obtained from a different server than the one that hosts the primary resource (usually, the Web page that the user is viewing). Third-party cookies are often used to correlate users' activity on different sites.¶

Because of their inherent privacy issues, most user agents now limit third-party cookies in a variety of ways. Some completely block third-party cookies by refusing to process third-party Set-Cookie header fields and refusing to send third-party Cookie header fields. Some partition cookies based upon the first-party context, so that different cookies are sent depending on the site being browsed. Some block cookies based upon user agent cookie policy and/or user controls.¶

While this document does not endorse or require a specific approach, it is RECOMMENDED that user agents adopt a policy for third-party cookies that is as restrictive as compatibility constraints permit. Consequently, resources cannot rely upon third-party cookies being treated consistently by user agents for the foreseeable future.¶

7.2. Cookie Policy

User agents MAY enforce a cookie policy consisting of restrictions on how cookies may be used or ignored (see Section 5.3).¶

A cookie policy may govern which domains or parties, as in first and third parties (see Section 7.1), for which the user agent will allow cookie access. The policy can also define limits on cookie size, cookie expiry (see Section 4.1.2.1 and Section 4.1.2.2), and the number of cookies per domain or in total.¶

The recomended cookie expiry upper limit is 400 days. User agents may set a lower limit to enforce shorter data retention timelines, or set the limit higher to support longer retention when appropriate (e.g., server-to-server communication over HTTPS).¶

The goal of a restrictive cookie policy is often to improve security or privacy. User agents often allow users to change the cookie policy (see Section 7.3).¶

7.3. User Controls

User agents SHOULD provide users with a mechanism for managing the cookies stored in the cookie store. For example, a user agent might let users delete all cookies received during a specified time period or all the cookies related to a particular domain. In addition, many user agents include a user interface element that lets users examine the cookies stored in their cookie store.¶

User agents SHOULD provide users with a mechanism for disabling cookies. When cookies are disabled, the user agent MUST NOT include a Cookie header field in outbound HTTP requests and the user agent MUST NOT process Set-Cookie header fields in inbound HTTP responses.¶

User agents MAY offer a way to change the cookie policy (see Section 7.2).¶

User agents MAY provide users the option of preventing persistent storage of cookies across sessions. When configured thusly, user agents MUST treat all received cookies as if the persistent-flag were set to false. Some popular user agents expose this functionality via "private browsing" mode [Aggarwal2010].¶

7.4. Expiration Dates

Although servers can set the expiration date for cookies to the distant future, most user agents do not actually retain cookies for multiple decades. Rather than choosing gratuitously long expiration periods, servers SHOULD promote user privacy by selecting reasonable cookie expiration periods based on the purpose of the cookie. For example, a typical session identifier might reasonably be set to expire in two weeks.¶

8.1. Overview

Cookies have a number of security pitfalls. This section overviews a few of the more salient issues.¶

In particular, cookies encourage developers to rely on ambient authority for authentication, often becoming vulnerable to attacks such as cross-site request forgery [CSRF]. Also, when storing session identifiers in cookies, developers often create session fixation vulnerabilities.¶

Transport-layer encryption, such as that employed in HTTPS, is insufficient to prevent a network attacker from obtaining or altering a victim's cookies because the cookie protocol itself has various vulnerabilities (see "Weak Confidentiality" and "Weak Integrity", below). In addition, by default, cookies do not provide confidentiality or integrity from network attackers, even when used in conjunction with HTTPS.¶

8.2. Ambient Authority

A server that uses cookies to authenticate users can suffer security vulnerabilities because some user agents let remote parties issue HTTP requests from the user agent (e.g., via HTTP redirects or HTML forms). When issuing those requests, user agents attach cookies even if the remote party does not know the contents of the cookies, potentially letting the remote party exercise authority at an unwary server.¶

Although this security concern goes by a number of names (e.g., cross-site request forgery, confused deputy), the issue stems from cookies being a form of ambient authority. Cookies encourage server operators to separate designation (in the form of URLs) from authorization (in the form of cookies). Consequently, the user agent might supply the authorization for a resource designated by the attacker, possibly causing the server or its clients to undertake actions designated by the attacker as though they were authorized by the user.¶

Instead of using cookies for authorization, server operators might wish to consider entangling designation and authorization by treating URLs as capabilities. Instead of storing secrets in cookies, this approach stores secrets in URLs, requiring the remote entity to supply the secret itself. Although this approach is not a panacea, judicious application of these principles can lead to more robust security.¶

8.3. Clear Text

Unless sent over a secure channel (such as TLS), the information in the Cookie and Set-Cookie header fields is transmitted in the clear.¶

1. All sensitive information conveyed in these header fields is exposed to an eavesdropper.¶
2. A malicious intermediary could alter the header fields as they travel in either direction, with unpredictable results.¶
3. A malicious client could alter the Cookie header fields before transmission, with unpredictable results.¶

Servers SHOULD encrypt and sign the contents of cookies (using whatever format the server desires) when transmitting them to the user agent (even when sending the cookies over a secure channel). However, encrypting and signing cookie contents does not prevent an attacker from transplanting a cookie from one user agent to another or from replaying the cookie at a later time.¶

In addition to encrypting and signing the contents of every cookie, servers that require a higher level of security SHOULD use the Cookie and Set-Cookie header fields only over a secure channel. When using cookies over a secure channel, servers SHOULD set the Secure attribute (see Section 4.1.2.5) for every cookie. If a server does not set the Secure attribute, the protection provided by the secure channel will be largely moot.¶

For example, consider a webmail server that stores a session identifier in a cookie and is typically accessed over HTTPS. If the server does not set the Secure attribute on its cookies, an active network attacker can intercept any outbound HTTP request from the user agent and redirect that request to the webmail server over HTTP. Even if the webmail server is not listening for HTTP connections, the user agent will still include cookies in the request. The active network attacker can intercept these cookies, replay them against the server, and learn the contents of the user's email. If, instead, the server had set the Secure attribute on its cookies, the user agent would not have included the cookies in the clear-text request.¶

8.4. Session Identifiers

Instead of storing session information directly in a cookie (where it might be exposed to or replayed by an attacker), servers commonly store a nonce (or "session identifier") in a cookie. When the server receives an HTTP request with a nonce, the server can look up state information associated with the cookie using the nonce as a key.¶

Using session identifier cookies limits the damage an attacker can cause if the attacker learns the contents of a cookie because the nonce is useful only for interacting with the server (unlike non-nonce cookie content, which might itself be sensitive). Furthermore, using a single nonce prevents an attacker from "splicing" together cookie content from two interactions with the server, which could cause the server to behave unexpectedly.¶

Using session identifiers is not without risk. For example, the server SHOULD take care to avoid "session fixation" vulnerabilities. A session fixation attack proceeds in three steps. First, the attacker transplants a session identifier from his or her user agent to the victim's user agent. Second, the victim uses that session identifier to interact with the server, possibly imbuing the session identifier with the user's credentials or confidential information. Third, the attacker uses the session identifier to interact with server directly, possibly obtaining the user's authority or confidential information.¶

8.5. Weak Confidentiality

Cookies do not provide isolation by port. If a cookie is readable by a service running on one port, the cookie is also readable by a service running on another port of the same server. If a cookie is writable by a service on one port, the cookie is also writable by a service running on another port of the same server. For this reason, servers SHOULD NOT both run mutually distrusting services on different ports of the same host and use cookies to store security-sensitive information.¶

Cookies do not provide isolation by scheme. Although most commonly used with the http and https schemes, the cookies for a given host might also be available to other schemes, such as ftp and gopher. Although this lack of isolation by scheme is most apparent in non-HTTP APIs that permit access to cookies (e.g., HTML's document.cookie API), the lack of isolation by scheme is actually present in requirements for processing cookies themselves (e.g., consider retrieving a URI with the gopher scheme via HTTP).¶

Cookies do not always provide isolation by path. Although the network-level protocol does not send cookies stored for one path to another, some user agents expose cookies via non-HTTP APIs, such as HTML's document.cookie API. Because some of these user agents (e.g., web browsers) do not isolate resources received from different paths, a resource retrieved from one path might be able to access cookies stored for another path.¶

8.6. Weak Integrity

Cookies do not provide integrity guarantees for sibling domains (and their subdomains). For example, consider foo.site.example and bar.site.example. The foo.site.example server can set a cookie with a Domain attribute of "site.example" (possibly overwriting an existing "site.example" cookie set by bar.site.example), and the user agent will include that cookie in HTTP requests to bar.site.example. In the worst case, bar.site.example will be unable to distinguish this cookie from a cookie it set itself. The foo.site.example server might be able to leverage this ability to mount an attack against bar.site.example.¶

Even though the Set-Cookie header field supports the Path attribute, the Path attribute does not provide any integrity protection because the user agent will accept an arbitrary Path attribute in a Set-Cookie header field. For example, an HTTP response to a request for http://site.example/foo/bar can set a cookie with a Path attribute of "/qux". Consequently, servers SHOULD NOT both run mutually distrusting services on different paths of the same host and use cookies to store security-sensitive information.¶

An active network attacker can also inject cookies into the Cookie header field sent to https://site.example/ by impersonating a response from http://site.example/ and injecting a Set-Cookie header field. The HTTPS server at site.example will be unable to distinguish these cookies from cookies that it set itself in an HTTPS response. An active network attacker might be able to leverage this ability to mount an attack against site.example even if site.example uses HTTPS exclusively.¶

Servers can partially mitigate these attacks by encrypting and signing the contents of their cookies, or by naming the cookie with the __Secure- prefix. However, using cryptography does not mitigate the issue completely because an attacker can replay a cookie he or she received from the authentic site.example server in the user's session, with unpredictable results.¶

Finally, an attacker might be able to force the user agent to delete cookies by storing a large number of cookies. Once the user agent reaches its storage limit, the user agent will be forced to evict some cookies. Servers SHOULD NOT rely upon user agents retaining cookies.¶

8.7. Reliance on DNS

Cookies rely upon the Domain Name System (DNS) for security. If the DNS is partially or fully compromised, the cookie protocol might fail to provide the security properties required by applications.¶

8.8. SameSite Cookies

9.1. Cookie

The permanent message header field registry (see [RFC3864]) needs to be updated with the following registration:¶

Header field name:

Cookie¶

Applicable protocol:

http¶

Status:

standard¶

Author/Change controller:

IETF¶

Specification document:

this specification (Section 5.7.1)¶

9.2. Set-Cookie

The permanent message header field registry (see [RFC3864]) needs to be updated with the following registration:¶

Header field name:

Set-Cookie¶

Applicable protocol:

http¶

Status:

standard¶

Author/Change controller:

IETF¶

Specification document:

this specification (Section 5.5)¶

9.3. Cookie Attribute Registry

IANA is requested to create the "Cookie Attribute Registry", defining the name space of attribute used to control cookies' behavior. The registry should be maintained at https://www.iana.org/assignments/cookie-attribute-names.¶

A.1. draft-ietf-httpbis-rfc6265bis-00

• Port [RFC6265] to Markdown. No (intentional) normative changes.¶

A.2. draft-ietf-httpbis-rfc6265bis-01

• Fixes to formatting caused by mistakes in the initial port to Markdown:¶

  • https://github.com/httpwg/http-extensions/issues/243¶
  • https://github.com/httpwg/http-extensions/issues/246¶
• Addresses errata 3444 by updating the path-value and extension-av grammar, errata 4148 by updating the day-of-month, year, and time grammar, and errata 3663 by adding the requested note. https://www.rfc-editor.org/errata_search.php?rfc=6265¶
• Dropped Cookie2 and Set-Cookie2 from the IANA Considerations section: https://github.com/httpwg/http-extensions/issues/247¶
• Merged the recommendations from [I-D.ietf-httpbis-cookie-alone], removing the ability for a non-secure origin to set cookies with a 'secure' flag, and to overwrite cookies whose 'secure' flag is true.¶
• Merged the recommendations from [I-D.ietf-httpbis-cookie-prefixes], adding __Secure- and __Host- cookie name prefix processing instructions.¶

A.3. draft-ietf-httpbis-rfc6265bis-02

• Merged the recommendations from [I-D.ietf-httpbis-cookie-same-site], adding support for the SameSite attribute.¶

• Closed a number of editorial bugs:¶

  • Clarified address bar behavior for SameSite cookies: https://github.com/httpwg/http-extensions/issues/201¶
  • Added the word "Cookies" to the document's name: https://github.com/httpwg/http-extensions/issues/204¶
  • Clarified that the __Host- prefix requires an explicit Path attribute: https://github.com/httpwg/http-extensions/issues/222¶
  • Expanded the options for dealing with third-party cookies to include a brief mention of partitioning based on first-party: https://github.com/httpwg/http-extensions/issues/248¶
  • Noted that double-quotes in cookie values are part of the value, and are not stripped: https://github.com/httpwg/http-extensions/issues/295¶
  • Fixed the "site for cookies" algorithm to return something that makes sense: https://github.com/httpwg/http-extensions/issues/302¶

A.4. draft-ietf-httpbis-rfc6265bis-03

• Clarified handling of invalid SameSite values: https://github.com/httpwg/http-extensions/issues/389¶
• Reflect widespread implementation practice of including a cookie's host-only-flag when calculating its uniqueness: https://github.com/httpwg/http-extensions/issues/199¶
• Introduced an explicit "None" value for the SameSite attribute: https://github.com/httpwg/http-extensions/issues/788¶

A.5. draft-ietf-httpbis-rfc6265bis-04

• Allow SameSite cookies to be set for all top-level navigations. https://github.com/httpwg/http-extensions/issues/594¶
• Treat Set-Cookie: token as creating the cookie ("", "token"): https://github.com/httpwg/http-extensions/issues/159¶
• Reject cookies with neither name nor value (e.g. Set-Cookie: = and Set-Cookie:: https://github.com/httpwg/http-extensions/issues/159¶
• Clarified behavior of multiple SameSite attributes in a cookie string: https://github.com/httpwg/http-extensions/issues/901¶

A.6. draft-ietf-httpbis-rfc6265bis-05

• Typos and editorial fixes: https://github.com/httpwg/http-extensions/pull/1035, https://github.com/httpwg/http-extensions/pull/1038, https://github.com/httpwg/http-extensions/pull/1040, https://github.com/httpwg/http-extensions/pull/1047.¶

A.7. draft-ietf-httpbis-rfc6265bis-06

• Editorial fixes: https://github.com/httpwg/http-extensions/issues/1059, https://github.com/httpwg/http-extensions/issues/1158.¶
• Created a registry for cookie attribute names: https://github.com/httpwg/http-extensions/pull/1060.¶
• Tweaks to ABNF for cookie-pair and the Cookie header production: https://github.com/httpwg/http-extensions/issues/1074, https://github.com/httpwg/http-extensions/issues/1119.¶
• Fixed serialization for nameless/valueless cookies: https://github.com/httpwg/http-extensions/pull/1143.¶
• Converted a normative reference to Mozilla's Public Suffix List [PSL] into an informative reference: https://github.com/httpwg/http-extensions/issues/1159.¶

A.8. draft-ietf-httpbis-rfc6265bis-07

• Moved instruction to ignore cookies with empty cookie-name and cookie-value from Section 5.5 to Section 5.6 to ensure that they apply to cookies created without parsing a cookie string: https://github.com/httpwg/http-extensions/issues/1234.¶
• Add a default enforcement value to the same-site-flag, equivalent to "SameSite=Lax": https://github.com/httpwg/http-extensions/pull/1325.¶
• Require a Secure attribute for "SameSite=None": https://github.com/httpwg/http-extensions/pull/1323.¶
• Consider scheme when running the same-site algorithm: https://github.com/httpwg/http-extensions/pull/1324.¶

A.9. draft-ietf-httpbis-rfc6265bis-08

• Define "same-site" for reload navigation requests, e.g. those triggered via user interface elements: https://github.com/httpwg/http-extensions/pull/1384¶
• Consider redirects when defining same-site: https://github.com/httpwg/http-extensions/pull/1348¶
• Align on using HTML terminology for origins: https://github.com/httpwg/http-extensions/pull/1416¶
• Modify cookie parsing and creation algorithms in Section 5.5 and Section 5.6 to explicitly handle control characters: https://github.com/httpwg/http-extensions/pull/1420¶
• Refactor cookie retrieval algorithm to support non-HTTP APIs: https://github.com/httpwg/http-extensions/pull/1428¶
• Define "Lax-allowing-unsafe" SameSite enforcement mode: https://github.com/httpwg/http-extensions/pull/1435¶
• Consistently use "header field" (vs 'header"): https://github.com/httpwg/http-extensions/pull/1527¶

A.10. draft-ietf-httpbis-rfc6265bis-09

• Update cookie size requirements: https://github.com/httpwg/http-extensions/pull/1563¶
• Reject cookies with control characters: https://github.com/httpwg/http-extensions/pull/1576¶
• No longer treat horizontal tab as a control character: https://github.com/httpwg/http-extensions/pull/1589¶
• Specify empty domain attribute handling: https://github.com/httpwg/http-extensions/pull/1709¶

A.11. draft-ietf-httpbis-rfc6265bis-10

• Standardize Max-Age/Expires upper bound: https://github.com/httpwg/http-extensions/pull/1732, https://github.com/httpwg/http-extensions/pull/1980.¶
• Expand on privacy considerations and third-party cookies: https://github.com/httpwg/http-extensions/pull/1878¶
• Specify that no decoding of Set-Cookie line should occur: https://github.com/httpwg/http-extensions/pull/1902¶
• Require ASCII for domain attributes: https://github.com/httpwg/http-extensions/pull/1969¶
• Typos, formatting and editorial fixes: https://github.com/httpwg/http-extensions/pull/1789, https://github.com/httpwg/http-extensions/pull/1858, https://github.com/httpwg/http-extensions/pull/2069.¶

A.12. draft-ietf-httpbis-rfc6265bis-11

• Remove note to ignore Domain attribute with trailing dot: https://github.com/httpwg/http-extensions/pull/2087, https://github.com/httpwg/http-extensions/pull/2092.¶
• Remove an inadvertant change to cookie-octet: https://github.com/httpwg/http-extensions/pull/2090¶
• Remove note regarding cookie serialization: https://github.com/httpwg/http-extensions/pull/2165¶
• Add case insensitivity note to Set-Cookie Syntax: https://github.com/httpwg/http-extensions/pull/2167¶
• Add note not to send invalid cookies due to public suffix list changes: https://github.com/httpwg/http-extensions/pull/2215¶
• Add warning to not send nameless cookies: https://github.com/httpwg/http-extensions/pull/2220¶
• Add note regarding Service Worker's computation of "site for cookies": https://github.com/httpwg/http-extensions/pull/2217¶
• Compare cookie name prefixes case-insensitively: https://github.com/httpwg/http-extensions/pull/2236¶
• Update editors and the acknowledgements https://github.com/httpwg/http-extensions/pull/2244¶
• Prevent nameless cookies with prefixed values https://github.com/httpwg/http-extensions/pull/2251¶

A.13. draft-ietf-httpbis-rfc6265bis-12

• Advise the reader which section to implement https://github.com/httpwg/http-extensions/pull/2478¶
• Define top-level navigation https://github.com/httpwg/http-extensions/pull/2481¶
• Use navigables concept https://github.com/httpwg/http-extensions/pull/2478¶