Skip to content

Consistently trim whitespace from name and value #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 9, 2025
Merged

Consistently trim whitespace from name and value #281

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5902d58
Consistently trim whitespace from name and value
annevk Aug 7, 2025
606fc8c
CI
annevk Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,13 @@ Per [[RFC6265BIS-14#name-storage-model|Cookies § Storage Model]], a [=cookie=]

</div>

<div algorithm>

To <dfn local-lt=normalize>normalize a cookie name or value</dfn> given a [=/string=] |input|:
remove all U+0009 TAB and U+0020 SPACE that are at the start or end of |input|.

</div>

A cookie is <dfn>script-visible</dfn> when it is in-scope and its [=cookie/http-only-flag=] is unset. This is more formally enforced in the processing model, which consults [[RFC6265BIS-14#name-retrieval-model|Cookies § Retrieval Model]] at appropriate points.

A cookie is also subject to certain size limits. Per [[RFC6265BIS-14#name-storage-model|Cookies § Storage Model]]:
Expand Down Expand Up @@ -548,7 +555,7 @@ The <dfn method for=CookieStore>get(|options|)</dfn> method steps are:
1. Run the following steps [=in parallel=]:
1. Let |list| be the results of running [=query cookies=] with
|url| and
|options|["{{CookieStoreGetOptions/name}}"] (if present).
|options|["{{CookieStoreGetOptions/name}}"] [=map/with default=] null.
1. If |list| is failure, then [=reject=] |p| with a {{TypeError}} and abort these steps.
1. If |list| [=list/is empty=], then [=/resolve=] |p| with null.
1. Otherwise, [=/resolve=] |p| with the first item of |list|.
Expand Down Expand Up @@ -605,7 +612,7 @@ The <dfn method for=CookieStore>getAll(|options|)</dfn> method steps are:
1. Run the following steps [=in parallel=]:
1. Let |list| be the results of running [=query cookies=] with
|url| and
|options|["{{CookieStoreGetOptions/name}}"] (if present).
|options|["{{CookieStoreGetOptions/name}}"] [=map/with default=] null.
1. If |list| is failure, then [=reject=] |p| with a {{TypeError}}.
1. Otherwise, [=/resolve=] |p| with |list|.
1. Return |p|.
Expand Down Expand Up @@ -781,6 +788,7 @@ The <dfn method for=CookieStoreManager>subscribe(|subscriptions|)</dfn> method s
1. Let |subscription list| be |registration|'s associated [=cookie change subscription list=].
1. [=list/For each=] |entry| in |subscriptions|, run these steps:
1. Let |name| be |entry|["{{CookieStoreGetOptions/name}}"].
1. [=Normalize=] |name|.
1. Let |url| be the result of [=basic URL parser|parsing=] |entry|["{{CookieStoreGetOptions/url}}"] with |settings|'s [=environment settings object/API base URL=].
1. If |url| does not start with |registration|'s [=service worker registration/scope url=],
then [=reject=] |p| with a {{TypeError}} and abort these steps.
Expand Down Expand Up @@ -837,6 +845,7 @@ The <dfn method for=CookieStoreManager>unsubscribe(|subscriptions|)</dfn> method
1. Let |subscription list| be |registration|'s associated [=cookie change subscription list=].
1. [=list/For each=] |entry| in |subscriptions|, run these steps:
1. Let |name| be |entry|["{{CookieStoreGetOptions/name}}"].
1. [=Normalize=] |name|.
1. Let |url| be the result of [=basic URL parser|parsing=] |entry|["{{CookieStoreGetOptions/url}}"] with |settings|'s [=environment settings object/API base URL=].
1. If |url| does not start with |registration|'s [=service worker registration/scope url=],
then [=reject=] |p| with a {{TypeError}} and abort these steps.
Expand Down Expand Up @@ -1006,10 +1015,7 @@ and return a [=byte sequence=] corresponding to the closest `cookie-date` repres

<div algorithm>

To <dfn>query cookies</dfn> with
|url| and
optional |name|,
run the following steps:
To <dfn>query cookies</dfn> given a [=/URL=] |url| and [=/string=]-or-null |name|:

1. Perform the steps defined in [[RFC6265BIS-14#name-retrieval-model|Cookies § Retrieval Model]] to compute the "cookie-string from a given cookie store"
with |url| as <var ignore>request-uri</var>.
Expand All @@ -1020,7 +1026,8 @@ run the following steps:
1. Let |list| be a new [=/list=].
1. [=list/For each=] |cookie| in |cookie-list|, run these steps:
1. Assert: |cookie|'s [=cookie/http-only-flag=] is false.
1. If |name| is given, then run these steps:
1. If |name| is non-null:
1. [=Normalize=] |name|.
1. Let |cookieName| be the result of running [=UTF-8 decode without BOM=] on |cookie|'s [=cookie/name=].
1. If |cookieName| does not equal |name|,
then [=iteration/continue=].
Expand Down Expand Up @@ -1059,8 +1066,8 @@ optional |expires|,
|partitioned|
run the following steps:

1. Remove all U+0009 TAB and U+0020 SPACE that are at the start or end of |name|.
1. Remove all U+0009 TAB and U+0020 SPACE that are at the start or end of |value|.
1. [=Normalize=] |name|.
1. [=Normalize=] |value|.
1. If |name| or |value| contain U+003B (;), any [=C0 control=] character except U+0009 TAB, or U+007F DELETE, then return failure.

ISSUE(httpwg/http-extensions#1593): Note that it's up for discussion whether these character restrictions should also apply to |expires|, |domain|, |path|, and |sameSite| as well.
Expand Down Expand Up @@ -1138,6 +1145,8 @@ run the following steps:
Note: The exact value of |expires| is not important for the purposes of this algorithm,
as long as it is in the past.

1. [=Normalize=] |name|.

1. Let |value| be the empty string.

1. If |name|'s [=string/length=] is 0, then set |value| to any non-empty [=implementation-defined=] string.
Expand Down