[PR #11178/915338c7 backport][3.12] Fix cookie header parser ignoring reserved names #11181
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a backport of PR #11178 as merged into master (915338c).
What do these changes do?
This PR fixes the Cookie header parser to correctly handle reserved attribute names (like
path
,domain
,secure
) as regular cookies, per RFC 6265 Section 5.4.Previously, Cookie headers like
session=abc123; path=/api; secure=true
would only parsesession=abc123
, incorrectly ignoringpath
andsecure
. Now all three are correctly parsed as cookies.The fix:
parse_cookie_header()
function specifically for RFC 6265 compliant Cookie header parsingparse_cookie_headers()
toparse_set_cookie_headers()
for clarityAre there changes in behavior for the user?
Yes, Cookie headers containing reserved attribute names will now be parsed differently:
Before:
After:
This is the correct behavior per RFC 6265 and matches what web browsers do.
Is it a substantial burden for the maintainers to support this?
No. This change:
Related issue number
This has likely been an issue since the beginning, as we previously used Python's
SimpleCookie
which has the same incorrect behavior. Now that we have our own parser (from PR #11112), we can fix this RFC compliance issue.Checklist
CONTRIBUTORS.txt
CHANGES/
foldername it
<issue_or_pr_num>.<type>.rst
(e.g.588.bugfix.rst
)if you don't have an issue number, change it to the pull request
number after creating the PR
.bugfix
: A bug fix for something the maintainers deemed animproper undesired behavior that got corrected to match
pre-agreed expectations.
.feature
: A new behavior, public APIs. That sort of stuff..deprecation
: A declaration of future API removals and breakingchanges in behavior.
.breaking
: When something public is removed in a breaking way.Could be deprecated in an earlier release.
.doc
: Notable updates to the documentation structure or buildprocess.
.packaging
: Notes for downstreams about unobvious side effectsand tooling. Changes in the test invocation considerations and
runtime assumptions.
.contrib
: Stuff that affects the contributor experience. e.g.Running tests, building the docs, setting up the development
environment.
.misc
: Changes that are hard to assign to any of the abovecategories.
Make sure to use full sentences with correct case and punctuation,
for example:
Use the past tense or the present tense a non-imperative mood,
referring to what's changed compared to the last released version
of this project.