umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 20:30:23 +00:00
Code Issues Wiki Activity

Add cowboy_req:filter_cookies/2

Browse source
This commit is contained in:
Loïc Hoguin 2019-10-05 11:23:57 +02:00
parent 5ffb4f98e0
commit 03dac1486d
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
5 changed files with 126 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/src/manual/cowboy_req.asciidoc
View file

@ -53,6 +53,7 @@ Processed request:
* link:man:cowboy_req:parse_qs(3)[cowboy_req:parse_qs(3)] - Parse the query string
* link:man:cowboy_req:match_qs(3)[cowboy_req:match_qs(3)] - Match the query string against constraints
* link:man:cowboy_req:parse_header(3)[cowboy_req:parse_header(3)] - Parse the given HTTP header
* link:man:cowboy_req:filter_cookies(3)[cowboy_req:filter_cookies(3)] - Filter cookie headers
* link:man:cowboy_req:parse_cookies(3)[cowboy_req:parse_cookies(3)] - Parse cookie headers
* link:man:cowboy_req:match_cookies(3)[cowboy_req:match_cookies(3)] - Match cookies against constraints
* link:man:cowboy_req:binding(3)[cowboy_req:binding(3)] - Access a value bound from the route

70
doc/src/manual/cowboy_req.filter_cookies.asciidoc Normal file
View file

@ -0,0 +1,70 @@
= cowboy_req:filter_cookies(3)
== Name
cowboy_req:filter_cookies - Filter cookie headers
== Description
[source,erlang]
----
filter_cookies(Names, Req) -> Req
Names :: [atom() | binary()]
----
Filter cookie headers.
This function is meant to be used before attempting to parse
or match cookies in order to remove cookies that are not
relevant and are potentially malformed. Because Cowboy by
default crashes on malformed cookies, this function allows
processing requests that would otherwise result in a 400
error.
Malformed cookies are unfortunately fairly common due to
the string-based interface provided by browsers and this
function provides a middle ground between Cowboy's strict
behavior and chaotic real world use cases.
Note that there may still be crashes even after filtering
cookies because this function does not correct malformed
values. Cookies that have malformed values should probably
be unset in an error response or in a redirect.
This function can be called even if there are no cookies
in the request.
== Arguments
Names::
The cookies that should be kept.
Req::
The Req object.
== Return value
The Req object is returned with its cookie header value
filtered.
== Changelog
* *2.7*: Function introduced.
== Examples
.Filter then parse cookies
[source,erlang]
----
Req = cowboy_req:filter_cookies([session_id, token], Req0),
Cookies = cowboy_req:parse_cookies(Req).
----
== See also
link:man:cowboy_req(3)[cowboy_req(3)],
link:man:cowboy_req:parse_cookies(3)[cowboy_req:parse_cookies(3)],
link:man:cowboy_req:match_cookies(3)[cowboy_req:match_cookies(3)]